1RTCFormat(3)             Embree Ray Tracing Kernels 4             RTCFormat(3)
2
3
4
5   NAME
6              RTCFormat - specifies format of data in buffers
7
8   SYNOPSIS
9              #include <embree4/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                RTC_FORMAT_QUATERNION_DECOMPOSITION
44              };
45
46   DESCRIPTION
47       The  RTFormat  structure defines the data format stored in data buffers
48       provided to Embree using the [rtcSetGeometryBuffer], [rtcSetSharedGeom‐
49       etryBuffer], and [rtcSetNewGeometryBuffer] API calls.
50
51       The  RTC_FORMAT_UINT/2/3/4 format are used to specify that data buffers
52       store unsigned integers, or unsigned integer vectors of size 2,3 or  4.
53       This  format  has  typically to get used when specifying index buffers,
54       e.g. RTC_FORMAT_UINT3 for triangle meshes.
55
56       The RTC_FORMAT_FLOAT/2/3/4... format are used to specify that data buf‐
57       fers  store single precision floating point values, or vectors there of
58       (size 2,3,4, etc.).  This format is typcally used to specify to  format
59       of  vertex  buffers, e.g. the RTC_FORMAT_FLOAT3 type for vertex buffers
60       of triangle meshes.
61
62       The RTC_FORMAT_FLOAT3X4_ROW_MAJOR and  RTC_FORMAT_FLOAT3X4_COLUMN_MAJOR
63       formats, specify a 3x4 floating point matrix layed out either row major
64       or  column  major.   The  RTC_FORMAT_FLOAT4X4_ROW_MAJOR  and   RTC_FOR‐
65       MAT_FLOAT4X4_COLUMN_MAJOR  formats, specify a 4x4 floating point matrix
66       layed out either row major or  column  major.   The  RTC_FORMAT_QUATER‐
67       NION_DECOMPOSITION  format  specifies  a  structure  that  represents a
68       quaternion  decomposition  (see  [RTCQuaternionDecomposition])  of   an
69       affine  transformation.  These formats are used in the [rtcSetGeometry‐
70       Transform]  function  or  in  geometry  buffers  with   type   RTC_BUF‐
71       FER_TYPE_TRANSFORM in order to set a transformation matrix for instance
72       and instance array geometries.
73
74       The RTC_FORMAT_GRID is a special data format used to specify grid prim‐
75       itives of layout RTCGrid when creating grid geometries (see [RTC_GEOME‐
76       TRY_TYPE_GRID]).
77
78   EXIT STATUS
79   SEE ALSO
80       [rtcSetGeometryBuffer], [rtcSetSharedGeometryBuffer],  [rtcSetNewGeome‐
81       tryBuffer], [rtcSetGeometryTransform] [RTCQuaternionDecomposition]
82
83
84
85                                                                  RTCFormat(3)
Impressum