rtcReleaseScene.3embree3 822 B

12345678910111213141516171819202122232425262728293031323334
  1. .TH "rtcReleaseScene" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcReleaseScene\ \-\ decrements\ the\ scene\ reference\ count
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. void\ rtcReleaseScene(RTCScene\ scene);
  15. \f[]
  16. .fi
  17. .SS DESCRIPTION
  18. .PP
  19. Scene objects are reference counted.
  20. The \f[C]rtcReleaseScene\f[] function decrements the reference count of
  21. the passed scene object (\f[C]scene\f[] argument).
  22. When the reference count falls to 0, the scene gets destroyed.
  23. .PP
  24. The scene holds a reference to all attached geometries, thus if the
  25. scene gets destroyed, all geometries get detached and their reference
  26. count decremented.
  27. .SS EXIT STATUS
  28. .PP
  29. On failure an error code is set that can be queried using
  30. \f[C]rtcGetDeviceError\f[].
  31. .SS SEE ALSO
  32. .PP
  33. [rtcNewScene], [rtcRetainScene]