rtcRetainDevice.3embree3 769 B

1234567891011121314151617181920212223242526272829303132
  1. .TH "rtcRetainDevice" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcRetainDevice\ \-\ increments\ the\ device\ reference\ count
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. void\ rtcRetainDevice(RTCDevice\ device);
  15. \f[]
  16. .fi
  17. .SS DESCRIPTION
  18. .PP
  19. Device objects are reference counted.
  20. The \f[C]rtcRetainDevice\f[] function increments the reference count of
  21. the passed device object (\f[C]device\f[] argument).
  22. This function together with \f[C]rtcReleaseDevice\f[] allows to use the
  23. internal reference counting in a C++ wrapper class to manage 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. [rtcNewDevice], [rtcReleaseDevice]