|
@@ -2823,14 +2823,16 @@ namespace bgfx
|
|
|
, uint16_t _depth = UINT16_MAX
|
|
, uint16_t _depth = UINT16_MAX
|
|
|
);
|
|
);
|
|
|
|
|
|
|
|
- /// Request screen shot.
|
|
|
|
|
|
|
+ /// Request screen shot of window back buffer.
|
|
|
///
|
|
///
|
|
|
- /// @param[in] _handle Frame buffer handle.
|
|
|
|
|
|
|
+ /// @param[in] _handle Frame buffer handle. If handle is `BGFX_INVALID_HANDLE` request will be
|
|
|
|
|
+ /// made for main window back buffer.
|
|
|
/// @param[in] _filePath Will be passed to `bgfx::CallbackI::screenShot` callback.
|
|
/// @param[in] _filePath Will be passed to `bgfx::CallbackI::screenShot` callback.
|
|
|
///
|
|
///
|
|
|
/// @remarks
|
|
/// @remarks
|
|
|
/// `bgfx::CallbackI::screenShot` must be implemented.
|
|
/// `bgfx::CallbackI::screenShot` must be implemented.
|
|
|
///
|
|
///
|
|
|
|
|
+ /// @attention Frame buffer handle must be created with OS' target native window handle.
|
|
|
/// @attention C99 equivalent is `bgfx_request_screen_shot`.
|
|
/// @attention C99 equivalent is `bgfx_request_screen_shot`.
|
|
|
///
|
|
///
|
|
|
void requestScreenShot(FrameBufferHandle _handle, const char* _filePath);
|
|
void requestScreenShot(FrameBufferHandle _handle, const char* _filePath);
|