1RTCFormat(3)             Embree Ray Tracing Kernels 3             RTCFormat(3)
2
3
4
5   NAME
6              RTCFormat - specifies format of data in buffers
7
8   SYNOPSIS
9              #include <embree3/rtcore_ray.h>
10
11              enum RTCFormat
12              {
13                RTC_FORMAT_UINT,
14                RTC_FORMAT_UINT2,
15                RTC_FORMAT_UINT3,
16                RTC_FORMAT_UINT4,
17
18                RTC_FORMAT_FLOAT,
19                RTC_FORMAT_FLOAT2,
20                RTC_FORMAT_FLOAT3,
21                RTC_FORMAT_FLOAT4,
22                RTC_FORMAT_FLOAT5,
23                RTC_FORMAT_FLOAT6,
24                RTC_FORMAT_FLOAT7,
25                RTC_FORMAT_FLOAT8,
26                RTC_FORMAT_FLOAT9,
27                RTC_FORMAT_FLOAT10,
28                RTC_FORMAT_FLOAT11,
29                RTC_FORMAT_FLOAT12,
30                RTC_FORMAT_FLOAT13,
31                RTC_FORMAT_FLOAT14,
32                RTC_FORMAT_FLOAT15,
33                RTC_FORMAT_FLOAT16,
34
35                RTC_FORMAT_FLOAT3X4_ROW_MAJOR,
36                RTC_FORMAT_FLOAT4X4_ROW_MAJOR,
37
38                RTC_FORMAT_FLOAT3X4_COLUMN_MAJOR,
39                RTC_FORMAT_FLOAT4X4_COLUMN_MAJOR,
40
41                RTC_FORMAT_GRID,
42
43       };
44
45   DESCRIPTION
46       The  RTFormat  structure defines the data format stored in data buffers
47       provided to Embree using the [rtcSetGeometryBuffer], [rtcSetSharedGeom‐
48       etryBuffer], and [rtcSetNewGeometryBuffer] API calls.
49
50       The  RTC_FORMAT_UINT/2/3/4 format are used to specify that data buffers
51       store unsigned integers, or unsigned integer vectors of size 2,3 or  4.
52       This  format  has  typically to get used when specifying index buffers,
53       e.g. RTC_FORMAT_UINT3 for triangle meshes.
54
55       The RTC_FORMAT_FLOAT/2/3/4... format are used to specify that data buf‐
56       fers  store single precision floating point values, or vectors there of
57       (size 2,3,4, etc.).  This format is typcally used to specify to  format
58       of  vertex  buffers, e.g. the RTC_FORMAT_FLOAT3 type for vertex buffers
59       of triangle meshes.
60
61       The RTC_FORMAT_FLOAT3X4_ROW_MAJOR and  RTC_FORMAT_FLOAT3X4_COLUMN_MAJOR
62       formats, specify a 3x4 floating point matrix layed out either row major
63       or  column  major.   The  RTC_FORMAT_FLOAT4X4_ROW_MAJOR  and   RTC_FOR‐
64       MAT_FLOAT4X4_COLUMN_MAJOR  formats, specify a 4x4 floating point matrix
65       layed out either row major or column major.  These matrix  formats  are
66       used in the [rtcSetGeometryTransform] function in order to set a trans‐
67       formation matrix for geometries.
68
69       The RTC_FORMAT_GRID is a special data format used to specify grid prim‐
70       itives of layout RTCGrid when creating grid geometries (see [RTC_GEOME‐
71       TRY_TYPE_GRID]).
72
73   EXIT STATUS
74   SEE ALSO
75       [rtcSetGeometryBuffer], [rtcSetSharedGeometryBuffer],  [rtcSetNewGeome‐
76       tryBuffer], [rtcSetGeometryTransform]
77
78
79
80                                                                  RTCFormat(3)
Impressum