rtcRetainScene.3embree3 756 B

1234567891011121314151617181920212223242526272829303132
  1. .TH "rtcRetainScene" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcRetainScene\ \-\ increments\ 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\ rtcRetainScene(RTCScene\ scene);
  15. \f[]
  16. .fi
  17. .SS DESCRIPTION
  18. .PP
  19. Scene objects are reference counted.
  20. The \f[C]rtcRetainScene\f[] function increments the reference count of
  21. the passed scene object (\f[C]scene\f[] argument).
  22. This function together with \f[C]rtcReleaseScene\f[] allows to use the
  23. internal reference counting in a C++ wrapper class to handle the
  24. ownership of the object.
  25. .SS EXIT STATUS
  26. .PP
  27. On failure an error code is set that can be queried using
  28. \f[C]rtcGetDeviceError\f[].
  29. .SS SEE ALSO
  30. .PP
  31. [rtcNewScene], [rtcReleaseScene]