rtcSetGeometryTimeRange.3embree3 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .TH "rtcSetGeometryTimeRange" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcSetGeometryTimeRange\ \-\ sets\ the\ time\ range\ for\ a\ motion\ blur\ geometry
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. void\ rtcSetGeometryTimeRange(
  15. \ \ RTCGeometry\ geometry,
  16. \ \ float\ startTime,
  17. \ \ float\ endTime
  18. );
  19. \f[]
  20. .fi
  21. .SS DESCRIPTION
  22. .PP
  23. The \f[C]rtcSetGeometryTimeRange\f[] function sets a time range which
  24. defines the start (and end time) of the first (and last) time step of a
  25. motion blur geometry.
  26. The time range is defined relative to the camera shutter interval [0,1]
  27. but it can be arbitrary.
  28. Thus the startTime can be smaller, equal, or larger 0, indicating a
  29. geometry whose animation definition start before, at, or after the
  30. camera shutter opens.
  31. Similar the endTime can be smaller, equal, or larger than 1, indicating
  32. a geometry whose animation definition ends after, at, or before the
  33. camera shutter closes.
  34. The startTime has to be smaller or equal to the endTime.
  35. .PP
  36. The default time range when this function is not called is the entire
  37. camera shutter [0,1].
  38. For best performance at most one time segment of the piece wise linear
  39. definition of the motion should fall outside the shutter window to the
  40. left and to the right.
  41. Thus do not set the startTime or endTime too far outside the [0,1]
  42. interval for best performance.
  43. .PP
  44. This time range feature will also allow geometries to appear and
  45. disappear during the camera shutter time if the specified time range is
  46. a sub range of [0,1].
  47. .PP
  48. Please also have a look at the \f[C]rtcSetGeometryTimeStepCount\f[]
  49. function to see how to define the time steps for the specified time
  50. range.
  51. .SS EXIT STATUS
  52. .PP
  53. On failure an error code is set that can be queried using
  54. \f[C]rtcGetDeviceError\f[].
  55. .SS SEE ALSO
  56. .PP
  57. [rtcSetGeometryTimeStepCount]