diff --git a/doc/changes/misc_features/mr.2322.md b/doc/changes/misc_features/mr.2322.md index 5a61668c0..60eb4379c 100644 --- a/doc/changes/misc_features/mr.2322.md +++ b/doc/changes/misc_features/mr.2322.md @@ -1,4 +1,5 @@ --- - mr.2322 +- mr.2333 --- - Doxygen improvements. diff --git a/src/xrt/include/xrt/xrt_compositor.h b/src/xrt/include/xrt/xrt_compositor.h index a0d694890..3ee40b169 100644 --- a/src/xrt/include/xrt/xrt_compositor.h +++ b/src/xrt/include/xrt/xrt_compositor.h @@ -2169,6 +2169,12 @@ struct xrt_image_native /*! * Is the native buffer handle a DXGI handle? + * + * - If true, it is some kind of weird global handle, not reference counted, but + * widely compatible with various images. Ostensibly deprecated, but works the best + * on Windows. + * - If false, it's either not Windows, or a reference counted "NT Handle" + * which has awkward limitations, such as "usually no depth images allowed". */ bool is_dxgi_handle; };