rtcSetGeometryTransform.3embree3 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .TH "rtcSetGeometryTransform" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcSetGeometryTransform\ \-\ sets\ the\ transformation\ for\ a\ particular
  7. \ \ time\ step\ of\ an\ instance\ geometry
  8. \f[]
  9. .fi
  10. .SS SYNOPSIS
  11. .IP
  12. .nf
  13. \f[C]
  14. #include\ <embree3/rtcore.h>
  15. void\ rtcSetGeometryTransform(
  16. \ \ RTCGeometry\ geometry,
  17. \ \ unsigned\ int\ timeStep,
  18. \ \ enum\ RTCFormat\ format,
  19. \ \ const\ float*\ xfm
  20. );
  21. \f[]
  22. .fi
  23. .SS DESCRIPTION
  24. .PP
  25. The \f[C]rtcSetGeometryTransform\f[] function sets the local\-to\-world
  26. affine transformation (\f[C]xfm\f[] parameter) of an instance geometry
  27. (\f[C]geometry\f[] parameter) for a particular time step
  28. (\f[C]timeStep\f[] parameter).
  29. The transformation is specified as a 3×4 matrix (3×3 linear
  30. transformation plus translation), for which the following formats
  31. (\f[C]format\f[] parameter) are supported:
  32. .IP \[bu] 2
  33. \f[C]RTC_FORMAT_FLOAT3X4_ROW_MAJOR\f[]: The 3×4 float matrix is laid out
  34. in row\-major form.
  35. .IP \[bu] 2
  36. \f[C]RTC_FORMAT_FLOAT3X4_COLUMN_MAJOR\f[]: The 3×4 float matrix is laid
  37. out in column\-major form.
  38. .IP \[bu] 2
  39. \f[C]RTC_FORMAT_FLOAT4X4_COLUMN_MAJOR\f[]: The 3×4 float matrix is laid
  40. out in column\-major form as a 4×4 homogeneous matrix with the last row
  41. being equal to (0, 0, 0, 1).
  42. .SS EXIT STATUS
  43. .PP
  44. On failure an error code is set that can be queried using
  45. \f[C]rtcGetDeviceError\f[].
  46. .SS SEE ALSO
  47. .PP
  48. [RTC_GEOMETRY_TYPE_INSTANCE]