rtcNewBuffer.3embree3 986 B

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. .TH "rtcNewBuffer" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcNewBuffer\ \-\ creates\ a\ new\ data\ buffer
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. RTCBuffer\ rtcNewBuffer(
  15. \ \ RTCDevice\ device,
  16. \ \ size_t\ byteSize
  17. );
  18. \f[]
  19. .fi
  20. .SS DESCRIPTION
  21. .PP
  22. The \f[C]rtcNewBuffer\f[] function creates a new data buffer object of
  23. specified size in bytes (\f[C]byteSize\f[] argument) that is bound to
  24. the specified device (\f[C]device\f[] argument).
  25. The buffer object is reference counted with an initial reference count
  26. of 1.
  27. The returned buffer object can be released using the
  28. \f[C]rtcReleaseBuffer\f[] API call.
  29. The specified number of bytes are allocated at buffer construction time
  30. and deallocated when the buffer is destroyed.
  31. .IP
  32. .nf
  33. \f[C]
  34. \f[]
  35. .fi
  36. .SS EXIT STATUS
  37. .PP
  38. On failure \f[C]NULL\f[] is returned and an error code is set that can
  39. be queried using \f[C]rtcGetDeviceError\f[].
  40. .SS SEE ALSO
  41. .PP
  42. [rtcRetainBuffer], [rtcReleaseBuffer]