-
bgfx - Documentation¶
+
+
bgfx - API Reference¶
bgfx is Cross-platform, graphics API agnostic, “Bring Your Own Engine/Framework” style rendering library.
@@ -442,6 +446,8 @@ rendering library.Updating¶
+
+
+
Reset¶
-
void
bgfx::reset(uint32_t _width, uint32_t _height, uint32_t _flags)¶
@@ -457,7 +463,7 @@ rendering library.
_height - Back-buffer height.
_flags - -
+
_flags-See:
BGFX_RESET_*for more info.BGFX_RESET_NONE- No reset flags.BGFX_RESET_FULLSCREEN- Not supported yet.BGFX_RESET_MSAA_X[2/4/8/16]- Enable 2, 4, 8 or 16 x MSAA.
@@ -467,7 +473,9 @@ rendering library.
BGFX_RESET_HMD- HMD stereo rendering.BGFX_RESET_HMD_DEBUG- HMD stereo rendering debug mode.BGFX_RESET_HMD_RECENTER- HMD calibration.
+BGFX_RESET_FLUSH_AFTER_RENDER- Flush rendering after submitting to GPU.BGFX_RESET_FLIP_AFTER_RENDER- This flag specifies where flip occurs. Default behavior is that flip occurs before rendering new frame. This flag only has effect whenBGFX_CONFIG_MULTITHREADED=0.
+BGFX_RESET_SRGB_BACKBUFFER- Enable sRGB backbuffer.
@@ -477,6 +485,99 @@ rendering library.
+-
+
BGFX_RESET_NONE¶
+ No reset flags.
+-
+
BGFX_RESET_FULLSCREEN¶
+ Not supported yet.
+-
+
BGFX_RESET_MSAA_X2¶
+ Enable 2x MSAA.
+-
+
BGFX_RESET_MSAA_X4¶
+ Enable 4x MSAA.
+-
+
BGFX_RESET_MSAA_X8¶
+ Enable 8x MSAA.
+-
+
BGFX_RESET_MSAA_X16¶
+ Enable 16x MSAA.
+-
+
BGFX_RESET_VSYNC¶
+ Enable V-Sync.
+-
+
BGFX_RESET_MAXANISOTROPY¶
+ Turn on/off max anisotropy.
+-
+
BGFX_RESET_CAPTURE¶
+ Begin screen capture.
+-
+
BGFX_RESET_HMD¶
+ HMD stereo rendering.
+-
+
BGFX_RESET_HMD_DEBUG¶
+ HMD stereo rendering debug mode.
+-
+
BGFX_RESET_HMD_RECENTER¶
+ HMD calibration.
+-
+
BGFX_RESET_FLUSH_AFTER_RENDER¶
+ Flush rendering after submitting to GPU.
+-
+
BGFX_RESET_FLIP_AFTER_RENDER¶
+ This flag specifies where flip occurs. Default behavior is that flip occurs before rendering new frame. This flag only has effect when
+BGFX_CONFIG_MULTITHREADED=0.-
+
BGFX_RESET_SRGB_BACKBUFFER¶
+ Enable sRGB backbuffer.
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Debug¶
@@ -1456,6 +1558,8 @@ In graphics debugger view name will appear as:Draw¶
+Draw state is not preserved between two draw calls. All state is cleared after calling +bgfx::submit.
State¶
@@ -2009,6 +2113,8 @@ otherwise prefer bgfx::setViewScissor.
Compute¶
+Compute state is not preserved between two compute dispatches. All state is cleared after calling +bgfx::dispatch.
Buffers¶
-
@@ -2286,74 +2392,37 @@ otherwise prefer bgfx::setViewScissor.
-
Frame buffers¶
+
+
-Shaders and Programs¶
-
-
-
-FrameBufferHandle
bgfx::createFrameBuffer(BackbufferRatio::Enum _ratio, TextureFormat::Enum _format, uint32_t _textureFlags)¶
- Create frame buffer with size based on backbuffer ratio. Frame buffer will maintain ratio if back buffer resolution changes.
+-
+ShaderHandle
bgfx::createShader(const Memory *_mem)¶
+ Create shader from memory buffer.
- Attention -
- C99 equivalent is
bgfx_create_frame_buffer_scaled.
- - Parameters -
-
-
_ratio-Frame buffer size in respect to back-buffer size. See:
-BackbufferRatio::Enum.
-_format-Texture format. See:
-TextureFormat::Enum.
-_textureFlags-Default texture sampling mode is linear, and wrap mode is repeat.
-
-
BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]- Mirror or clamp to edge wrap mode.
-BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]- Point or anisotropic sampling.
-
-
+- C99 equivalent is
bgfx_create_shader.
-
-
-
-FrameBufferHandle
bgfx::createFrameBuffer(uint8_t _num, TextureHandle *_handles, bool _destroyTextures)¶
- Create frame buffer.
--
-
- Attention -
- C99 equivalent is
bgfx_create_frame_buffer_from_handles.
- - Parameters -
-
-
_num-Number of texture attachments.
-
-_handles-Texture attachments.
-
-_destroyTextures-If true, textures will be destroyed when frame buffer is destroyed.
-
-
-
-
-
-
-FrameBufferHandle
bgfx::createFrameBuffer(void *_nwh, uint16_t _width, uint16_t _height, TextureFormat::Enum _depthFormat)¶
- Create frame buffer for multiple window rendering.
+-
+uint16_t
bgfx::getShaderUniforms(ShaderHandle _handle, UniformHandle *_uniforms, uint16_t _max)¶
+ Returns num of uniforms, and uniform handles used inside shader.
- Return -
- Handle to frame buffer object. +
- Number of uniforms used by shader.
- Remark -
- Frame buffer cannnot be used for sampling. +
- Only non-predefined uniforms are returned.
- Attention -
- C99 equivalent is
bgfx_create_frame_buffer_from_nwh.
+ - C99 equivalent is
bgfx_get_shader_uniforms. - Parameters
-
-
_nwh-OS’ target native window handle.
+_handle-Shader handle.
-_width-Window back buffer width.
+_uniforms-UniformHandle array where data will be stored.
-_height-Window back buffer height.
-
-_depthFormat-Window back buffer depth format.
+_max-Maximum capacity of array.
@@ -2362,184 +2431,106 @@ otherwise prefer bgfx::setViewScissor.
-
-
-
-void
bgfx::destroyFrameBuffer(FrameBufferHandle _handle)¶
- Destroy frame buffer.
+-
+void
bgfx::destroyShader(ShaderHandle _handle)¶
+ Destroy shader. Once program is created with shader it is safe to destroy shader.
- Attention -
- C99 equivalent is
bgfx_destroy_frame_buffer.
+ - C99 equivalent is
bgfx_destroy_shader.
+
-
+
-
+ProgramHandle
bgfx::createProgram(ShaderHandle _vsh, ShaderHandle _fsh, bool _destroyShaders)¶
+ Create program with vertex and fragment shaders.
+-
+
- Return +
- Program handle if vertex shader output and fragment shader input are matching, otherwise returns invalid program handle. +
- Attention +
- C99 equivalent is
bgfx_create_program.
+ - Parameters +
-
+
_vsh-Vertex shader.
+
+_fsh-Fragment shader.
+
+_destroyShaders-If true, shaders will be destroyed when program is destroyed.
+
+
+
-
+
-
+ProgramHandle
bgfx::createProgram(ShaderHandle _csh, bool _destroyShader)¶
+ Create program with compute shader.
+-
+
- Return +
- Program handle. +
- Attention +
- C99 equivalent is
bgfx_create_compute_program.
+ - Parameters +
-
+
_csh-Compute shader.
+
+_destroyShader-If true, shader will be destroyed when program is destroyed.
+
+
+
-
+
-
+void
bgfx::destroyProgram(ProgramHandle _handle)¶
+ Destroy program.
+-
+
- Attention +
- C99 equivalent is
bgfx_destroy_program.
-
-
Index Buffers¶
+
+
Uniforms¶
-
-
-
-IndexBufferHandle
bgfx::createIndexBuffer(const Memory *_mem, uint16_t _flags)¶
- Create static index buffer.
--
-
- Attention -
- C99 equivalent is
bgfx_create_index_buffer.
- - Parameters -
-
-
_mem-Index buffer data.
-
-_flags-Buffer creation flags.
-
-
BGFX_BUFFER_NONE- No flags.
-BGFX_BUFFER_COMPUTE_READ- Buffer will be read from by compute shader.
-BGFX_BUFFER_COMPUTE_WRITE- Buffer will be written into by compute shader. When buffer is created withBGFX_BUFFER_COMPUTE_WRITEflag it cannot be updated from CPU.
-BGFX_BUFFER_COMPUTE_READ_WRITE- Buffer will be used for read/write by compute shader.
-BGFX_BUFFER_ALLOW_RESIZE- Buffer will resize on buffer update if different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit existing buffer size. This flag has effect only on dynamic buffers.
-BGFX_BUFFER_INDEX32- Buffer is using 32-bit indices. This flag has effect only on index buffers.
-
-
-
-
-
-
-void
bgfx::destroyIndexBuffer(IndexBufferHandle _handle)¶
- Destroy static index buffer.
--
-
- Attention -
- C99 equivalent is
bgfx_destroy_index_buffer.
-
-
-
-
-DynamicIndexBufferHandle
bgfx::createDynamicIndexBuffer(uint32_t _num, uint16_t _flags)¶
- Create empty dynamic index buffer.
--
-
- Attention -
- C99 equivalent is
bgfx_create_dynamic_index_buffer.
- - Parameters -
-
-
_num-Number of indices.
-
-_flags-Buffer creation flags.
-
-
BGFX_BUFFER_NONE- No flags.
-BGFX_BUFFER_COMPUTE_READ- Buffer will be read from by compute shader.
-BGFX_BUFFER_COMPUTE_WRITE- Buffer will be written into by compute shader. When buffer is created withBGFX_BUFFER_COMPUTE_WRITEflag it cannot be updated from CPU.
-BGFX_BUFFER_COMPUTE_READ_WRITE- Buffer will be used for read/write by compute shader.
-BGFX_BUFFER_ALLOW_RESIZE- Buffer will resize on buffer update if different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit existing buffer size. This flag has effect only on dynamic buffers.
-BGFX_BUFFER_INDEX32- Buffer is using 32-bit indices. This flag has effect only on index buffers.
-
-
-
-
-
-
-DynamicIndexBufferHandle
bgfx::createDynamicIndexBuffer(const Memory *_mem, uint16_t _flags)¶
- Create dynamic index buffer and initialized it.
--
-
- Attention -
- C99 equivalent is
bgfx_create_dynamic_index_buffer_mem.
- - Parameters -
-
-
_mem-Index buffer data.
-
-_flags-Buffer creation flags.
-
-
BGFX_BUFFER_NONE- No flags.
-BGFX_BUFFER_COMPUTE_READ- Buffer will be read from by compute shader.
-BGFX_BUFFER_COMPUTE_WRITE- Buffer will be written into by compute shader. When buffer is created withBGFX_BUFFER_COMPUTE_WRITEflag it cannot be updated from CPU.
-BGFX_BUFFER_COMPUTE_READ_WRITE- Buffer will be used for read/write by compute shader.
-BGFX_BUFFER_ALLOW_RESIZE- Buffer will resize on buffer update if different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit existing buffer size. This flag has effect only on dynamic buffers.
-BGFX_BUFFER_INDEX32- Buffer is using 32-bit indices. This flag has effect only on index buffers.
-
-
-
-
-
-
-void
bgfx::updateDynamicIndexBuffer(DynamicIndexBufferHandle _handle, uint32_t _startIndex, const Memory *_mem)¶
- Update dynamic index buffer.
--
-
- Attention -
- C99 equivalent is
bgfx_update_dynamic_index_buffer.
- - Parameters -
-
-
_handle-Dynamic index buffer handle.
-
-_startIndex-Start index.
-
-_mem-Index buffer data.
-
-
-
-
-
-
-void
bgfx::destroyDynamicIndexBuffer(DynamicIndexBufferHandle _handle)¶
- Destroy dynamic index buffer.
--
-
- Attention -
- C99 equivalent is
bgfx_destroy_dynamic_index_buffer.
- - Parameters -
-
-
_handle-Dynamic index buffer handle.
-
-
-
-
-
-
-bool
bgfx::checkAvailTransientIndexBuffer(uint32_t _num)¶
- Returns true if internal transient index buffer has enough space.
--
-
- Attention -
- C99 equivalent is
bgfx_check_avail_transient_index_buffer.
- - Parameters -
-
-
_num-Number of indices.
-
-
-
-
-
-
-void
bgfx::allocTransientIndexBuffer(TransientIndexBuffer *_tib, uint32_t _num)¶
- Allocate transient index buffer.
+-
+UniformHandle
bgfx::createUniform(const char *_name, UniformType::Enum _type, uint16_t _num)¶
+ Create shader uniform parameter.
-
+
- Return +
- Handle to uniform object.
- Remark -
-
-
- You must call setIndexBuffer after alloc in order to avoid memory leak. -
- Only 16-bit index buffer is supported. -
- Predefined uniforms (declared in
bgfx_shader.sh):-
+
u_viewRect vec4(x, y, width, height)- view rectangle for current view.
+u_viewTexel vec4(1.0/width, 1.0/height, undef, undef)- inverse width and height
+u_view mat4- view matrix
+u_invView mat4- inverted view matrix
+u_proj mat4- projection matrix
+u_invProj mat4- inverted projection matrix
+u_viewProj mat4- concatenated view projection matrix
+u_invViewProj mat4- concatenated inverted view projection matrix
+u_model mat4[BGFX_CONFIG_MAX_BONES]- array of model matrices.
+u_modelView mat4- concatenated model view matrix, only first model matrix from array is used.
+u_modelViewProj mat4- concatenated model view projection matrix.
+u_alphaRef float- alpha reference value for alpha test.
+
- Attention -
- C99 equivalent is
bgfx_alloc_transient_index_buffer.
+ - C99 equivalent is
bgfx_create_uniform. - Parameters
-
-
_tib-TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls.
+_name-Uniform name in shader.
-_num-Number of indices to allocate.
+_type-Type of uniform (See:
+bgfx::UniformType).
+_num-Number of elements in array.
@@ -2547,6 +2538,34 @@ otherwise prefer bgfx::setViewScissor.
-
+
-
+void
bgfx::destroyUniform(UniformHandle _handle)¶
+ Destroy shader uniform parameter.
+-
+
- Attention +
- C99 equivalent is
bgfx_destroy_uniform.
+ - Parameters +
-
+
_handle-Handle to uniform object.
+
+
+
-
+
-
+struct
bgfx::UniformType¶
+ Uniform type enum.
+-
+
- Attention +
- C99 equivalent is
bgfx_uniform_type_t.
+
Vertex Buffers¶
@@ -2962,20 +2981,28 @@ otherwise prefer bgfx::setViewScissor.
-
-
Instance Buffer¶
+
+
-Index Buffers¶
-
-
-
-bool
bgfx::checkAvailInstanceDataBuffer(uint32_t _num, uint16_t _stride)¶
- Returns true if internal instance data buffer has enough space.
+-
+IndexBufferHandle
bgfx::createIndexBuffer(const Memory *_mem, uint16_t _flags)¶
+ Create static index buffer.
- Attention -
- C99 equivalent is
bgfx_check_avail_instance_data_buffer.
+ - C99 equivalent is
bgfx_create_index_buffer. - Parameters
-
-
_num-Number of instances.
+_mem-Index buffer data.
-_stride-Stride per instance.
+_flags-Buffer creation flags.
-
+
BGFX_BUFFER_NONE- No flags.
+BGFX_BUFFER_COMPUTE_READ- Buffer will be read from by compute shader.
+BGFX_BUFFER_COMPUTE_WRITE- Buffer will be written into by compute shader. When buffer is created withBGFX_BUFFER_COMPUTE_WRITEflag it cannot be updated from CPU.
+BGFX_BUFFER_COMPUTE_READ_WRITE- Buffer will be used for read/write by compute shader.
+BGFX_BUFFER_ALLOW_RESIZE- Buffer will resize on buffer update if different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit existing buffer size. This flag has effect only on dynamic buffers.
+BGFX_BUFFER_INDEX32- Buffer is using 32-bit indices. This flag has effect only on index buffers.
+
@@ -2984,75 +3011,143 @@ otherwise prefer bgfx::setViewScissor.
-
-
-
-const InstanceDataBuffer *
bgfx::allocInstanceDataBuffer(uint32_t _num, uint16_t _stride)¶
- Allocate instance data buffer.
+-
+void
bgfx::destroyIndexBuffer(IndexBufferHandle _handle)¶
+ Destroy static index buffer.
+-
+
- Attention +
- C99 equivalent is
bgfx_destroy_index_buffer.
+
-
+
-
+DynamicIndexBufferHandle
bgfx::createDynamicIndexBuffer(uint32_t _num, uint16_t _flags)¶
+ Create empty dynamic index buffer.
+-
+
- Attention +
- C99 equivalent is
bgfx_create_dynamic_index_buffer.
+ - Parameters +
-
+
_num-Number of indices.
+
+_flags-Buffer creation flags.
-
+
BGFX_BUFFER_NONE- No flags.
+BGFX_BUFFER_COMPUTE_READ- Buffer will be read from by compute shader.
+BGFX_BUFFER_COMPUTE_WRITE- Buffer will be written into by compute shader. When buffer is created withBGFX_BUFFER_COMPUTE_WRITEflag it cannot be updated from CPU.
+BGFX_BUFFER_COMPUTE_READ_WRITE- Buffer will be used for read/write by compute shader.
+BGFX_BUFFER_ALLOW_RESIZE- Buffer will resize on buffer update if different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit existing buffer size. This flag has effect only on dynamic buffers.
+BGFX_BUFFER_INDEX32- Buffer is using 32-bit indices. This flag has effect only on index buffers.
+
+
+
-
+
-
+DynamicIndexBufferHandle
bgfx::createDynamicIndexBuffer(const Memory *_mem, uint16_t _flags)¶
+ Create dynamic index buffer and initialized it.
+-
+
- Attention +
- C99 equivalent is
bgfx_create_dynamic_index_buffer_mem.
+ - Parameters +
-
+
_mem-Index buffer data.
+
+_flags-Buffer creation flags.
-
+
BGFX_BUFFER_NONE- No flags.
+BGFX_BUFFER_COMPUTE_READ- Buffer will be read from by compute shader.
+BGFX_BUFFER_COMPUTE_WRITE- Buffer will be written into by compute shader. When buffer is created withBGFX_BUFFER_COMPUTE_WRITEflag it cannot be updated from CPU.
+BGFX_BUFFER_COMPUTE_READ_WRITE- Buffer will be used for read/write by compute shader.
+BGFX_BUFFER_ALLOW_RESIZE- Buffer will resize on buffer update if different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit existing buffer size. This flag has effect only on dynamic buffers.
+BGFX_BUFFER_INDEX32- Buffer is using 32-bit indices. This flag has effect only on index buffers.
+
+
+
-
+
-
+void
bgfx::updateDynamicIndexBuffer(DynamicIndexBufferHandle _handle, uint32_t _startIndex, const Memory *_mem)¶
+ Update dynamic index buffer.
+-
+
- Attention +
- C99 equivalent is
bgfx_update_dynamic_index_buffer.
+ - Parameters +
-
+
_handle-Dynamic index buffer handle.
+
+_startIndex-Start index.
+
+_mem-Index buffer data.
+
+
+
-
+
-
+void
bgfx::destroyDynamicIndexBuffer(DynamicIndexBufferHandle _handle)¶
+ Destroy dynamic index buffer.
+-
+
- Attention +
- C99 equivalent is
bgfx_destroy_dynamic_index_buffer.
+ - Parameters +
-
+
_handle-Dynamic index buffer handle.
+
+
+
-
+
-
+bool
bgfx::checkAvailTransientIndexBuffer(uint32_t _num)¶
+ Returns true if internal transient index buffer has enough space.
+-
+
- Attention +
- C99 equivalent is
bgfx_check_avail_transient_index_buffer.
+ - Parameters +
-
+
_num-Number of indices.
+
+
+
-
+
-
+void
bgfx::allocTransientIndexBuffer(TransientIndexBuffer *_tib, uint32_t _num)¶
+ Allocate transient index buffer.
- Remark -
- You must call setInstanceDataBuffer after alloc in order to avoid memory leak. +
-
+
- You must call setIndexBuffer after alloc in order to avoid memory leak. +
- Only 16-bit index buffer is supported. +
- Attention -
- C99 equivalent is
bgfx_alloc_instance_data_buffer.
-
-
-Indirect Buffer¶
--
-
-
-IndirectBufferHandle
bgfx::createIndirectBuffer(uint32_t _num)¶
- Create draw indirect buffer.
--
-
- Attention -
- C99 equivalent is
bgfx_create_indirect_buffer.
-
-
-
-
-void
bgfx::destroyIndirectBuffer(IndirectBufferHandle _handle)¶
- Destroy draw indirect buffer.
--
-
- Attention -
- C99 equivalent is
bgfx_destroy_indirect_buffer.
-
-
Shaders and Programs¶
--
-
-
-ShaderHandle
bgfx::createShader(const Memory *_mem)¶
- Create shader from memory buffer.
--
-
- Attention -
- C99 equivalent is
bgfx_create_shader.
-
-
-
-
-uint16_t
bgfx::getShaderUniforms(ShaderHandle _handle, UniformHandle *_uniforms, uint16_t _max)¶
- Returns num of uniforms, and uniform handles used inside shader.
--
-
- Return -
- Number of uniforms used by shader. -
- Remark -
- Only non-predefined uniforms are returned. -
- Attention -
- C99 equivalent is
bgfx_get_shader_uniforms.
+ - C99 equivalent is
bgfx_alloc_transient_index_buffer. - Parameters
-
-
_handle-Shader handle.
+_tib-TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls.
-_uniforms-UniformHandle array where data will be stored.
-
-_max-Maximum capacity of array.
+_num-Number of indices to allocate.
@@ -3060,72 +3155,6 @@ otherwise prefer bgfx::setViewScissor.
-
-
-
-void
bgfx::destroyShader(ShaderHandle _handle)¶
- Destroy shader. Once program is created with shader it is safe to destroy shader.
--
-
- Attention -
- C99 equivalent is
bgfx_destroy_shader.
-
-
-
-
-ProgramHandle
bgfx::createProgram(ShaderHandle _vsh, ShaderHandle _fsh, bool _destroyShaders)¶
- Create program with vertex and fragment shaders.
--
-
- Return -
- Program handle if vertex shader output and fragment shader input are matching, otherwise returns invalid program handle. -
- Attention -
- C99 equivalent is
bgfx_create_program.
- - Parameters -
-
-
_vsh-Vertex shader.
-
-_fsh-Fragment shader.
-
-_destroyShaders-If true, shaders will be destroyed when program is destroyed.
-
-
-
-
-
-
-ProgramHandle
bgfx::createProgram(ShaderHandle _csh, bool _destroyShader)¶
- Create program with compute shader.
--
-
- Return -
- Program handle. -
- Attention -
- C99 equivalent is
bgfx_create_compute_program.
- - Parameters -
-
-
_csh-Compute shader.
-
-_destroyShader-If true, shader will be destroyed when program is destroyed.
-
-
-
-
-
-
-void
bgfx::destroyProgram(ProgramHandle _handle)¶
- Destroy program.
--
-
- Attention -
- C99 equivalent is
bgfx_destroy_program.
-
Textures¶
@@ -3416,40 +3445,74 @@ otherwise prefer bgfx::setViewScissor.
-
Uniforms¶
+
+
+Frame Buffers¶
-
-
-
-UniformHandle
bgfx::createUniform(const char *_name, UniformType::Enum _type, uint16_t _num)¶
- Create shader uniform parameter.
+-
+FrameBufferHandle
bgfx::createFrameBuffer(BackbufferRatio::Enum _ratio, TextureFormat::Enum _format, uint32_t _textureFlags)¶
+ Create frame buffer with size based on backbuffer ratio. Frame buffer will maintain ratio if back buffer resolution changes.
+-
+
- Attention +
- C99 equivalent is
bgfx_create_frame_buffer_scaled.
+ - Parameters +
-
+
_ratio-Frame buffer size in respect to back-buffer size. See:
+BackbufferRatio::Enum.
+_format-Texture format. See:
+TextureFormat::Enum.
+_textureFlags-Default texture sampling mode is linear, and wrap mode is repeat.
-
+
BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]- Mirror or clamp to edge wrap mode.
+BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]- Point or anisotropic sampling.
+
+
+
-
+
-
+FrameBufferHandle
bgfx::createFrameBuffer(uint8_t _num, TextureHandle *_handles, bool _destroyTextures)¶
+ Create frame buffer.
+-
+
- Attention +
- C99 equivalent is
bgfx_create_frame_buffer_from_handles.
+ - Parameters +
-
+
_num-Number of texture attachments.
+
+_handles-Texture attachments.
+
+_destroyTextures-If true, textures will be destroyed when frame buffer is destroyed.
+
+
+
-
+
-
+FrameBufferHandle
bgfx::createFrameBuffer(void *_nwh, uint16_t _width, uint16_t _height, TextureFormat::Enum _depthFormat)¶
+ Create frame buffer for multiple window rendering.
- Return -
- Handle to uniform object. +
- Handle to frame buffer object.
- Remark -
- Predefined uniforms (declared in
bgfx_shader.sh):-
-
u_viewRect vec4(x, y, width, height)- view rectangle for current view.
-u_viewTexel vec4(1.0/width, 1.0/height, undef, undef)- inverse width and height
-u_view mat4- view matrix
-u_invView mat4- inverted view matrix
-u_proj mat4- projection matrix
-u_invProj mat4- inverted projection matrix
-u_viewProj mat4- concatenated view projection matrix
-u_invViewProj mat4- concatenated inverted view projection matrix
-u_model mat4[BGFX_CONFIG_MAX_BONES]- array of model matrices.
-u_modelView mat4- concatenated model view matrix, only first model matrix from array is used.
-u_modelViewProj mat4- concatenated model view projection matrix.
-u_alphaRef float- alpha reference value for alpha test.
-
+ - Frame buffer cannnot be used for sampling.
- Attention -
- C99 equivalent is
bgfx_create_uniform.
+ - C99 equivalent is
bgfx_create_frame_buffer_from_nwh. - Parameters
-
-
_name-Uniform name in shader.
+_nwh-OS’ target native window handle.
-_type-Type of uniform (See:
+bgfx::UniformType)._width-Window back buffer width.
-_num-Number of elements in array.
+_height-Window back buffer height.
+
+_depthFormat-Window back buffer depth format.
@@ -3458,15 +3521,31 @@ otherwise prefer bgfx::setViewScissor.
+
+Instance Buffer¶
+-
+
-
+bool
bgfx::checkAvailInstanceDataBuffer(uint32_t _num, uint16_t _stride)¶
+ Returns true if internal instance data buffer has enough space.
+-
+
- Attention +
- C99 equivalent is
bgfx_check_avail_instance_data_buffer. - Parameters
-
-
_handle-Handle to uniform object.
+_num-Number of instances.
+
+_stride-Stride per instance.
@@ -3474,13 +3553,40 @@ otherwise prefer bgfx::setViewScissor.
-
-
-
-struct
bgfx::UniformType¶
- Uniform type enum.
+-
+
-
+const InstanceDataBuffer *
bgfx::allocInstanceDataBuffer(uint32_t _num, uint16_t _stride)¶
+ Allocate instance data buffer.
+-
+
- Remark +
- You must call setInstanceDataBuffer after alloc in order to avoid memory leak. +
- Attention +
- C99 equivalent is
bgfx_alloc_instance_data_buffer.
+
-
+const InstanceDataBuffer *
+
- Built with Sphinx using a theme provided by Read the Docs.
diff --git a/genindex.html b/genindex.html
index 073e51d0f..5451c05a4 100644
--- a/genindex.html
+++ b/genindex.html
@@ -71,10 +71,14 @@
Indirect Buffer¶
+-
+
-
+IndirectBufferHandle
bgfx::createIndirectBuffer(uint32_t _num)¶
+ Create draw indirect buffer.
- Attention -
- C99 equivalent is
bgfx_uniform_type_t.
+ - C99 equivalent is
bgfx_create_indirect_buffer.
+
-
+
-
+void
bgfx::destroyIndirectBuffer(IndirectBufferHandle _handle)¶
+ Destroy draw indirect buffer.
+-
+
- Attention +
- C99 equivalent is
bgfx_destroy_indirect_buffer.
-
-
- bgfx - Documentation
-
+
- bgfx - API Reference
- General
- Initialization and Shutdown -
- Updating +
- Updating +
- Debug
- Debug Features
- Debug Flags @@ -116,14 +120,14 @@
- Resources
- bgfx::Memory (C++ class)
- -- bgfx::PlatformData (C++ class) @@ -603,6 +605,8 @@
- bgfx::RendererType::Count (C++ class) +
- bgfx::RendererType::Direct3D11 (C++ class) @@ -948,6 +952,66 @@ +
- BGFX_RESET_CAPTURE (C macro) + + + +
- BGFX_RESET_FLIP_AFTER_RENDER (C macro) + + + +
- BGFX_RESET_FLUSH_AFTER_RENDER (C macro) + + + +
- BGFX_RESET_FULLSCREEN (C macro) + + + +
- BGFX_RESET_HMD (C macro) + + + +
- BGFX_RESET_HMD_DEBUG (C macro) + + + +
- BGFX_RESET_HMD_RECENTER (C macro) + + + +
- BGFX_RESET_MAXANISOTROPY (C macro) + + + +
- BGFX_RESET_MSAA_X16 (C macro) + + + +
- BGFX_RESET_MSAA_X2 (C macro) + + + +
- BGFX_RESET_MSAA_X4 (C macro) + + + +
- BGFX_RESET_MSAA_X8 (C macro) + + + +
- BGFX_RESET_NONE (C macro) + + + +
- BGFX_RESET_SRGB_BACKBUFFER (C macro) + + + +
- BGFX_RESET_VSYNC (C macro) + + +
- BGFX_STATE_ALPHA_WRITE (C macro) @@ -983,7 +1047,6 @@ © Copyright 2015, Branimir Karadžić. - Built with Sphinx using a theme provided by Read the Docs. diff --git a/index.html b/index.html index 503b02751..ca94e5e4c 100644 --- a/index.html +++ b/index.html @@ -31,7 +31,7 @@ - + @@ -71,10 +71,14 @@
- bgfx - Documentation
-
+
- bgfx - API Reference
- General
- Initialization and Shutdown -
- Updating +
- Updating +
- Debug
- Debug Features
- Debug Flags @@ -116,14 +120,14 @@
- Resources
Contents:
- Built with Sphinx using a theme provided by Read the Docs. diff --git a/objects.inv b/objects.inv index 5d0493bdc..be0f3c84c 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/search.html b/search.html index 492141227..189f1287e 100644 --- a/search.html +++ b/search.html @@ -70,10 +70,14 @@-
-
- bgfx - Documentation
-
+
- bgfx - API Reference
- General
- Initialization and Shutdown
- Updating @@ -196,14 +200,14 @@ rendering library.
- Resources
- General
- bgfx - API Reference
-
-
- bgfx - Documentation
-
+
- bgfx - API Reference
- General
- Initialization and Shutdown -
- Updating +
- Updating +
- Debug
- Debug Features
- Debug Flags @@ -115,14 +119,14 @@
- Resources
- General
- bgfx - API Reference
- General
- bgfx - API Reference
-
-
- General
- bgfx - API Reference