diff --git a/bgfx.html b/bgfx.html index 460fa7855..d43422ee0 100644 --- a/bgfx.html +++ b/bgfx.html @@ -203,6 +203,7 @@
formats[TextureFormat::Count]¶formats[TextureFormat::Count]¶
Supported texture formats.
BGFX_CAPS_FORMAT_TEXTURE_NONE - not supportedBGFX_CAPS_FORMAT_TEXTURE_COLOR - supportedBGFX_CAPS_FORMAT_TEXTURE_EMULATED - emulatedBGFX_CAPS_FORMAT_TEXTURE_2D - supportedBGFX_CAPS_FORMAT_TEXTURE_2D_EMULATED - emulatedBGFX_CAPS_FORMAT_TEXTURE_VERTEX - supported vertex texture bgfx::setViewRect(uint8_t _id, uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height)¶Set view rectangle. Draw primitive outside view will be clipped.
-bgfx_set_view_rect. _id - View id.
-_x - Position x from the left corner of the window.
-_y - Position y from the top corner of the window.
-_width - Width of view port region.
-_height - Height of view port region.
-Warning
+doxygenfunction: Unable to resolve multiple matches for function “bgfx::setViewRect” with arguments () in doxygen xml output for project “project0” from directory: ../../.build/docs/xml. +Potential matches:
- - ++- void bgfx::setViewRect(uint8_t, uint16_t, uint16_t, BackbufferRatio::Enum) +- void bgfx::setViewRect(uint8_t, uint16_t, uint16_t, uint16_t, uint16_t) ++
bgfx::setViewScissor(uint8_t _id, uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height)¶_handle - Frame buffer handle.
_attachment - Attachment index.
+_attachment - Frame buffer attachment index.
_flags - Texture sampling mode. Default value UINT32_MAX uses texture sampling settings from the texture.
BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP] - Mirror or clamp to edge wrap mode._handle - Frame buffer handle.
_attachment - Attachment index.
+_attachment - Frame buffer attachment index.
_access - Texture access. See Access::Enum.
bgfx::blit(uint8_t _id, TextureHandle _dst, uint16_t _dstX, uint16_t _dstY, TextureHandle _src, uint16_t _srcX, uint16_t _srcY, uint16_t _width, uint16_t _height)¶Blit texture 2D region between two 2D textures.
+Destination texture must be create with BGFX_TEXTURE_BLIT_DST flag.
Availability depends on: BGFX_CAPS_TEXTURE_BLIT.
C99 equivalent is bgfx_blit.
_id - View id.
+_dst - Destination texture handle.
+_dstX - Destination texture X position.
+_dstY - Destination texture Y position.
+_src - Source texture handle.
+_srcX - Source texture X position.
+_srcY - Source texture Y position.
+_width - Width of region.
+_height - Height of region.
+bgfx::blit(uint8_t _id, TextureHandle _dst, uint16_t _dstX, uint16_t _dstY, FrameBufferHandle _src, uint8_t _attachment, uint16_t _srcX, uint16_t _srcY, uint16_t _width, uint16_t _height)¶Blit texture 2D region between 2D frame buffer and 2D texture.
+Destination texture must be create with BGFX_TEXTURE_BLIT_DST flag.
Availability depends on: BGFX_CAPS_TEXTURE_BLIT.
C99 equivalent is bgfx_blit.
_id - View id.
+_dst - Destination texture handle.
+_dstX - Destination texture X position.
+_dstY - Destination texture Y position.
+_src - Source frame buffer handle.
+_attachment - Source frame buffer attachment index.
+_srcX - Source texture X position.
+_srcY - Source texture Y position.
+_width - Width of region.
+_height - Height of region.
+bgfx::blit(uint8_t _id, TextureHandle _dst, uint8_t _dstMip, uint16_t _dstX, uint16_t _dstY, uint16_t _dstZ, TextureHandle _src, uint8_t _srcMip, uint16_t _srcX, uint16_t _srcY, uint16_t _srcZ, uint16_t _width, uint16_t _height, uint16_t _depth)¶Blit texture region between two textures.
+Destination texture must be create with BGFX_TEXTURE_BLIT_DST flag.
Availability depends on: BGFX_CAPS_TEXTURE_BLIT.
C99 equivalent is bgfx_blit.
_id - View id.
+_dst - Destination texture handle.
+_dstMip - Destination texture mip level.
+_dstX - Destination texture X position.
+_dstY - Destination texture Y position.
+_dstZ - If texture is 2D this argument should be 0. If destination texture is cube this argument represent destination texture cube face. For 3D texture this argument represent destination texture Z position.
+_src - Source texture handle.
+_srcMip - Source texture mip level.
+_srcX - Source texture X position.
+_srcY - Source texture Y position.
+_srcZ - If texture is 2D this argument should be 0. If source texture is cube this argument represent source texture cube face. For 3D texture this argument represent source texture Z position.
+_width - Width of region.
+_height - Height of region.
+_depth - If texture is 3D this argument represent depth of region, otherwise is unused.
+bgfx::blit(uint8_t _id, TextureHandle _dst, uint8_t _dstMip, uint16_t _dstX, uint16_t _dstY, uint16_t _dstZ, FrameBufferHandle _src, uint8_t _attachment, uint8_t _srcMip, uint16_t _srcX, uint16_t _srcY, uint16_t _srcZ, uint16_t _width, uint16_t _height, uint16_t _depth)¶Blit texture region between frame buffer and texture.
+Destination texture must be create with BGFX_TEXTURE_BLIT_DST flag.
Availability depends on: BGFX_CAPS_TEXTURE_BLIT.
C99 equivalent is bgfx_blit.
_id - View id.
+_dst - Destination texture handle.
+_dstMip - Destination texture mip level.
+_dstX - Destination texture X position.
+_dstY - Destination texture Y position.
+_dstZ - If texture is 2D this argument should be 0. If destination texture is cube this argument represent destination texture cube face. For 3D texture this argument represent destination texture Z position.
+_src - Source frame buffer handle.
+_attachment - Source frame buffer attachment index.
+_srcMip - Source texture mip level.
+_srcX - Source texture X position.
+_srcY - Source texture Y position.
+_srcZ - If texture is 2D this argument should be 0. If source texture is cube this argument represent source texture cube face. For 3D texture this argument represent source texture Z position.
+_width - Width of region.
+_height - Height of region.
+_depth - If texture is 3D this argument represent depth of region, otherwise is unused.
+RG32F¶
+RGB9E5F¶BGRA8¶bgfx::readTexture(TextureHandle _handle, void *_data)¶Read back texture content.
+Texture must be created with BGFX_TEXTURE_READ_BACK flag.
Availability depends on: BGFX_CAPS_TEXTURE_READ_BACK.
C99 equivalent is bgfx_read_texture.
_handle - Texture handle.
+_data - Destination buffer.
+bgfx::readTexture(FrameBufferHandle _handle, uint8_t _attachment, void *_data)¶Read back texture content.
+Texture must be created with BGFX_TEXTURE_READ_BACK flag.
Availability depends on: BGFX_CAPS_TEXTURE_READ_BACK.
C99 equivalent is bgfx_read_texture.
_handle - Frame buffer handle.
+_attachment - Frame buffer attachment index.
+_data - Destination buffer.
+bgfx::destroyTexture(TextureHandle _handle)¶bgfx_destroy_texture. _handle - Texture handle.
+bgfx::createFrameBuffer(uint8_t _num, TextureHandle *_handles, bool _destroyTextures)¶Create frame buffer.
-bgfx_create_frame_buffer_from_handles. _num - Number of texture attachments.
-_handles - Texture attachments.
-_destroyTextures - If true, textures will be destroyed when frame buffer is destroyed.
-Warning
+doxygenfunction: Unable to resolve multiple matches for function “createFrameBuffer” with arguments (uint8_t, TextureHandle *, bool) in doxygen xml output for project “project0” from directory: ../../.build/docs/xml. +Potential matches:
- - ++- FrameBufferHandle bgfx::createFrameBuffer(void *, uint16_t, uint16_t, TextureFormat::Enum) +- FrameBufferHandle bgfx::createFrameBuffer(uint16_t, uint16_t, TextureFormat::Enum, uint32_t) +- FrameBufferHandle bgfx::createFrameBuffer(uint8_t, const TextureHandle *, bool) +- FrameBufferHandle bgfx::createFrameBuffer(BackbufferRatio::Enum, TextureFormat::Enum, uint32_t) ++
bgfx::createFrameBuffer(void *_nwh, uint16_t _width, uint16_t _height, TextureFormat::Enum _depthFormat)¶