From 14447049011bbddc34b3f7be3d8625e14fd07342 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Branimir=20Karad=C5=BEi=C4=87?= Date: Thu, 2 Mar 2017 19:29:34 -0800 Subject: [PATCH] Cleanup. --- examples/07-callback/callback.cpp | 2 +- examples/common/entry/entry.cpp | 4 ++-- include/bgfx/bgfx.h | 17 +++++++++++++++-- include/bgfx/c99/bgfx.h | 2 +- include/bgfx/c99/platform.h | 2 +- include/bgfx/defines.h | 2 +- src/bgfx.cpp | 14 +++++++------- src/bgfx_p.h | 12 ++++++------ src/renderer_d3d11.cpp | 2 +- src/renderer_d3d12.cpp | 2 +- src/renderer_d3d9.cpp | 2 +- src/renderer_gl.cpp | 2 +- src/renderer_mtl.mm | 4 ++-- src/renderer_noop.cpp | 2 +- src/renderer_vk.cpp | 2 +- 15 files changed, 42 insertions(+), 29 deletions(-) diff --git a/examples/07-callback/callback.cpp b/examples/07-callback/callback.cpp index 1c4a16d58..464e2e55e 100644 --- a/examples/07-callback/callback.cpp +++ b/examples/07-callback/callback.cpp @@ -440,7 +440,7 @@ int _main_(int _argc, char** _argv) if (150 == frame) { bgfx::FrameBufferHandle fbh = BGFX_INVALID_HANDLE; - bgfx::saveScreenShot(fbh, "temp/frame150"); + bgfx::requestScreenShot(fbh, "temp/frame150"); } // Advance to next frame. Rendering thread will be kicked to diff --git a/examples/common/entry/entry.cpp b/examples/common/entry/entry.cpp index 19237f60f..97701343d 100644 --- a/examples/common/entry/entry.cpp +++ b/examples/common/entry/entry.cpp @@ -316,7 +316,7 @@ BX_PRAGMA_DIAGNOSTIC_POP(); if (_argc > 2) { - bgfx::saveScreenShot(fbh, _argv[2]); + bgfx::requestScreenShot(fbh, _argv[2]); } else { @@ -325,7 +325,7 @@ BX_PRAGMA_DIAGNOSTIC_POP(); char filePath[256]; bx::snprintf(filePath, sizeof(filePath), "temp/screenshot-%d", tt); - bgfx::saveScreenShot(fbh, filePath); + bgfx::requestScreenShot(fbh, filePath); } return 0; diff --git a/include/bgfx/bgfx.h b/include/bgfx/bgfx.h index f41e89ae1..1bf759bc1 100644 --- a/include/bgfx/bgfx.h +++ b/include/bgfx/bgfx.h @@ -1215,6 +1215,8 @@ namespace bgfx /// Destroy static index buffer. /// + /// @param[in] _handle Static index buffer handle. + /// /// @attention C99 equivalent is `bgfx_destroy_index_buffer`. /// void destroyIndexBuffer(IndexBufferHandle _handle); @@ -1268,6 +1270,7 @@ namespace bgfx /// buffers. /// - `BGFX_BUFFER_INDEX32` - Buffer is using 32-bit indices. This flag has effect only on /// index buffers. + /// @returns Dynamic index buffer handle. /// /// @attention C99 equivalent is `bgfx_create_dynamic_index_buffer`. /// @@ -1291,6 +1294,7 @@ namespace bgfx /// buffers. /// - `BGFX_BUFFER_INDEX32` - Buffer is using 32-bit indices. This flag has effect only on /// index buffers. + /// @returns Dynamic index buffer handle. /// /// @attention C99 equivalent is `bgfx_create_dynamic_index_buffer_mem`. /// @@ -1337,6 +1341,7 @@ namespace bgfx /// buffers. /// - `BGFX_BUFFER_INDEX32` - Buffer is using 32-bit indices. This flag has effect only on /// index buffers. + /// @returns Dynamic vertex buffer handle. /// /// @attention C99 equivalent is `bgfx_create_dynamic_vertex_buffer`. /// @@ -1362,6 +1367,7 @@ namespace bgfx /// buffers. /// - `BGFX_BUFFER_INDEX32` - Buffer is using 32-bit indices. This flag has effect only on /// index buffers. + /// @returns Dynamic vertex buffer handle. /// /// @attention C99 equivalent is `bgfx_create_dynamic_vertex_buffer_mem`. /// @@ -1387,6 +1393,8 @@ namespace bgfx /// Destroy dynamic vertex buffer. /// + /// @param[in] _handle Dynamic vertex buffer handle. + /// /// @attention C99 equivalent is `bgfx_destroy_dynamic_vertex_buffer`. /// void destroyDynamicVertexBuffer(DynamicVertexBufferHandle _handle); @@ -1480,12 +1488,17 @@ namespace bgfx /// Create draw indirect buffer. /// + /// @param[in] _num Number of indirect calls. + /// @returns Indirect buffer handle. + /// /// @attention C99 equivalent is `bgfx_create_indirect_buffer`. /// IndirectBufferHandle createIndirectBuffer(uint32_t _num); /// Destroy draw indirect buffer. /// + /// @param[in] _handle Indirect buffer handle. + /// /// @attention C99 equivalent is `bgfx_destroy_indirect_buffer`. /// void destroyIndirectBuffer(IndirectBufferHandle _handle); @@ -2818,9 +2831,9 @@ namespace bgfx /// @remarks /// `bgfx::CallbackI::screenShot` must be implemented. /// - /// @attention C99 equivalent is `bgfx_save_screen_shot`. + /// @attention C99 equivalent is `bgfx_request_screen_shot`. /// - void saveScreenShot(FrameBufferHandle _handle, const char* _filePath); + void requestScreenShot(FrameBufferHandle _handle, const char* _filePath); } // namespace bgfx diff --git a/include/bgfx/c99/bgfx.h b/include/bgfx/c99/bgfx.h index d9581f945..6e4315d8a 100644 --- a/include/bgfx/c99/bgfx.h +++ b/include/bgfx/c99/bgfx.h @@ -909,6 +909,6 @@ BGFX_C_API void bgfx_discard(); BGFX_C_API void bgfx_blit(uint8_t _id, bgfx_texture_handle_t _dst, uint8_t _dstMip, uint16_t _dstX, uint16_t _dstY, uint16_t _dstZ, bgfx_texture_handle_t _src, uint8_t _srcMip, uint16_t _srcX, uint16_t _srcY, uint16_t _srcZ, uint16_t _width, uint16_t _height, uint16_t _depth); /**/ -BGFX_C_API void bgfx_save_screen_shot(bgfx_frame_buffer_handle_t _handle, const char* _filePath); +BGFX_C_API void bgfx_request_screen_shot(bgfx_frame_buffer_handle_t _handle, const char* _filePath); #endif // BGFX_C99_H_HEADER_GUARD diff --git a/include/bgfx/c99/platform.h b/include/bgfx/c99/platform.h index 62a353ca0..39e5ac015 100644 --- a/include/bgfx/c99/platform.h +++ b/include/bgfx/c99/platform.h @@ -198,7 +198,7 @@ typedef struct bgfx_interface_vtbl uint32_t (*dispatch_indirect)(uint8_t _id, bgfx_program_handle_t _handle, bgfx_indirect_buffer_handle_t _indirectHandle, uint16_t _start, uint16_t _num, uint8_t _flags); void (*discard)(); void (*blit)(uint8_t _id, bgfx_texture_handle_t _dst, uint8_t _dstMip, uint16_t _dstX, uint16_t _dstY, uint16_t _dstZ, bgfx_texture_handle_t _src, uint8_t _srcMip, uint16_t _srcX, uint16_t _srcY, uint16_t _srcZ, uint16_t _width, uint16_t _height, uint16_t _depth); - void (*save_screen_shot)(bgfx_frame_buffer_handle_t _handle, const char* _filePath); + void (*request_screen_shot)(bgfx_frame_buffer_handle_t _handle, const char* _filePath); } bgfx_interface_vtbl_t; diff --git a/include/bgfx/defines.h b/include/bgfx/defines.h index 373e02eaa..2b1614b5f 100644 --- a/include/bgfx/defines.h +++ b/include/bgfx/defines.h @@ -6,7 +6,7 @@ #ifndef BGFX_DEFINES_H_HEADER_GUARD #define BGFX_DEFINES_H_HEADER_GUARD -#define BGFX_API_VERSION UINT32_C(37) +#define BGFX_API_VERSION UINT32_C(38) /// #define BGFX_STATE_RGB_WRITE UINT64_C(0x0000000000000001) //!< Enable RGB write. diff --git a/src/bgfx.cpp b/src/bgfx.cpp index a68982233..4c8577f70 100644 --- a/src/bgfx.cpp +++ b/src/bgfx.cpp @@ -2447,7 +2447,7 @@ namespace bgfx } break; - case CommandBuffer::SaveScreenShot: + case CommandBuffer::RequestScreenShot: { FrameBufferHandle handle; _cmdbuf.read(handle); @@ -2457,7 +2457,7 @@ namespace bgfx const char* filePath = (const char*)_cmdbuf.skip(len); - m_renderCtx->saveScreenShot(handle, filePath); + m_renderCtx->requestScreenShot(handle, filePath); } break; @@ -3847,10 +3847,10 @@ error: s_ctx->blit(_id, _dst, _dstMip, _dstX, _dstY, _dstZ, _src, _srcMip, _srcX, _srcY, _srcZ, _width, _height, _depth); } - void saveScreenShot(FrameBufferHandle _handle, const char* _filePath) + void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) { BGFX_CHECK_MAIN_THREAD(); - s_ctx->saveScreenShot(_handle, _filePath); + s_ctx->requestScreenShot(_handle, _filePath); } } // namespace bgfx @@ -4778,10 +4778,10 @@ BGFX_C_API void bgfx_blit(uint8_t _id, bgfx_texture_handle_t _dst, uint8_t _dstM bgfx::blit(_id, dst.cpp, _dstMip, _dstX, _dstY, _dstZ, src.cpp, _srcMip, _srcX, _srcY, _srcZ, _width, _height, _depth); } -BGFX_C_API void bgfx_save_screen_shot(bgfx_frame_buffer_handle _handle, const char* _filePath) +BGFX_C_API void bgfx_request_screen_shot(bgfx_frame_buffer_handle _handle, const char* _filePath) { union { bgfx_frame_buffer_handle_t c; bgfx::FrameBufferHandle cpp; } handle = { _handle }; - bgfx::saveScreenShot(handle.cpp, _filePath); + bgfx::requestScreenShot(handle.cpp, _filePath); } BGFX_C_API bgfx_render_frame_t bgfx_render_frame() @@ -4948,7 +4948,7 @@ BGFX_C_API bgfx_interface_vtbl_t* bgfx_get_interface(uint32_t _version) BGFX_IMPORT_FUNC(dispatch_indirect) \ BGFX_IMPORT_FUNC(discard) \ BGFX_IMPORT_FUNC(blit) \ - BGFX_IMPORT_FUNC(save_screen_shot) + BGFX_IMPORT_FUNC(request_screen_shot) static bgfx_interface_vtbl_t s_bgfx_interface = { diff --git a/src/bgfx_p.h b/src/bgfx_p.h index 987d9d9ad..2bf30be72 100644 --- a/src/bgfx_p.h +++ b/src/bgfx_p.h @@ -646,7 +646,7 @@ namespace bgfx DestroyFrameBuffer, DestroyUniform, ReadTexture, - SaveScreenShot, + RequestScreenShot, }; void write(const void* _data, uint32_t _size) @@ -2166,7 +2166,7 @@ namespace bgfx virtual void destroyFrameBuffer(FrameBufferHandle _handle) = 0; virtual void createUniform(UniformHandle _handle, UniformType::Enum _type, uint16_t _num, const char* _name) = 0; virtual void destroyUniform(UniformHandle _handle) = 0; - virtual void saveScreenShot(FrameBufferHandle _handle, const char* _filePath) = 0; + virtual void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) = 0; virtual void updateViewName(uint8_t _id, const char* _name) = 0; virtual void updateUniform(uint16_t _loc, const void* _data, uint32_t _size) = 0; virtual void setMarker(const char* _marker, uint32_t _size) = 0; @@ -3625,18 +3625,18 @@ namespace bgfx m_freeOcclusionQueryHandle[m_numFreeOcclusionQueryHandles++] = _handle; } - BGFX_API_FUNC(void saveScreenShot(FrameBufferHandle _handle, const char* _filePath) ) + BGFX_API_FUNC(void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) ) { - BGFX_CHECK_HANDLE_INVALID_OK("saveScreenShot", m_frameBufferHandle, _handle); + BGFX_CHECK_HANDLE_INVALID_OK("requestScreenShot", m_frameBufferHandle, _handle); if (isValid(_handle) ) { FrameBufferRef& ref = m_frameBufferRef[_handle.idx]; - BX_CHECK(ref.m_window, "saveScreenShot can be done only for window frame buffer handles (handle: %d).", _handle.idx); BX_UNUSED(ref); + BX_CHECK(ref.m_window, "requestScreenShot can be done only for window frame buffer handles (handle: %d).", _handle.idx); BX_UNUSED(ref); return; } - CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::SaveScreenShot); + CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::RequestScreenShot); uint16_t len = (uint16_t)bx::strnlen(_filePath)+1; cmdbuf.write(_handle); cmdbuf.write(len); diff --git a/src/renderer_d3d11.cpp b/src/renderer_d3d11.cpp index 757526b77..54ac9b951 100644 --- a/src/renderer_d3d11.cpp +++ b/src/renderer_d3d11.cpp @@ -1975,7 +1975,7 @@ BX_PRAGMA_DIAGNOSTIC_POP(); m_uniformReg.remove(_handle); } - void saveScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE + void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE { IDXGISwapChain* swapChain = isValid(_handle) ? m_frameBuffers[_handle.idx].m_swapChain diff --git a/src/renderer_d3d12.cpp b/src/renderer_d3d12.cpp index 490c3edda..0936c0fa0 100644 --- a/src/renderer_d3d12.cpp +++ b/src/renderer_d3d12.cpp @@ -1559,7 +1559,7 @@ namespace bgfx { namespace d3d12 m_uniformReg.remove(_handle); } - void saveScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE + void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE { BX_UNUSED(_handle); diff --git a/src/renderer_d3d9.cpp b/src/renderer_d3d9.cpp index 45ecdc2c8..dcd0c0e0f 100644 --- a/src/renderer_d3d9.cpp +++ b/src/renderer_d3d9.cpp @@ -1129,7 +1129,7 @@ namespace bgfx { namespace d3d9 m_uniformReg.remove(_handle); } - void saveScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE + void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE { #if BX_PLATFORM_WINDOWS BX_UNUSED(_handle); diff --git a/src/renderer_gl.cpp b/src/renderer_gl.cpp index feaf75f5b..6966367bd 100644 --- a/src/renderer_gl.cpp +++ b/src/renderer_gl.cpp @@ -2523,7 +2523,7 @@ namespace bgfx { namespace gl m_uniformReg.remove(_handle); } - void saveScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE + void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE { SwapChainGL* swapChain = NULL; uint32_t width = m_resolution.m_width; diff --git a/src/renderer_mtl.mm b/src/renderer_mtl.mm index 87ff8719d..db45f468e 100644 --- a/src/renderer_mtl.mm +++ b/src/renderer_mtl.mm @@ -904,14 +904,14 @@ namespace bgfx { namespace mtl } //cmdPre - void saveScreenShotPre(const char* _filePath) BX_OVERRIDE + void requestScreenShotPre(const char* _filePath) BX_OVERRIDE { BX_UNUSED(_filePath); m_saveScreenshot = true; } //cmdPost - void saveScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE + void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) BX_OVERRIDE { BX_UNUSED(_handle); diff --git a/src/renderer_noop.cpp b/src/renderer_noop.cpp index 9436a4c5f..74edf5346 100644 --- a/src/renderer_noop.cpp +++ b/src/renderer_noop.cpp @@ -177,7 +177,7 @@ namespace bgfx { namespace noop { } - void saveScreenShot(FrameBufferHandle /*_handle*/, const char* /*_filePath*/) BX_OVERRIDE + void requestScreenShot(FrameBufferHandle /*_handle*/, const char* /*_filePath*/) BX_OVERRIDE { } diff --git a/src/renderer_vk.cpp b/src/renderer_vk.cpp index b33cd0398..91d7c48f6 100644 --- a/src/renderer_vk.cpp +++ b/src/renderer_vk.cpp @@ -2097,7 +2097,7 @@ VK_IMPORT_DEVICE m_uniforms[_handle.idx] = NULL; } - void saveScreenShot(FrameBufferHandle /*_handle*/, const char* /*_filePath*/) BX_OVERRIDE + void requestScreenShot(FrameBufferHandle /*_handle*/, const char* /*_filePath*/) BX_OVERRIDE { }