diff --git a/bgfx.html b/bgfx.html index 214e34880..1e0483809 100644 --- a/bgfx.html +++ b/bgfx.html @@ -2025,7 +2025,7 @@ creating windows.
bgfx::vertexPack(const float _input[4], bool _inputNormalized, Attrib::Enum _attr, const VertexLayout &_decl, void *_data, uint32_t _index = 0)¶bgfx::vertexPack(const float _input[4], bool _inputNormalized, Attrib::Enum _attr, const VertexLayout &_layout, void *_data, uint32_t _index = 0)¶Pack vertex attribute into vertex stream format.
C99 equivalent is bgfx_vertex_pack.
[in] _input: Value to be packed into vertex stream.
[in] _inputNormalized: True if input value is already normalized.
[in] _attr: Attribute to pack.
[in] _decl: Vertex stream layout.
[in] _layout: Vertex stream layout.
[in] _data: Destination vertex stream where data will be packed.
[in] _index: Vertex index that will be modified.
bgfx::vertexUnpack(float _output[4], Attrib::Enum _attr, const VertexLayout &_decl, const void *_data, uint32_t _index = 0)¶bgfx::vertexUnpack(float _output[4], Attrib::Enum _attr, const VertexLayout &_layout, const void *_data, uint32_t _index = 0)¶Unpack vertex attribute from vertex stream format.
C99 equivalent is bgfx_vertex_unpack.
[out] _output: Result of unpacking.
[in] _attr: Attribute to unpack.
[in] _decl: Vertex stream layout.
[in] _layout: Vertex stream layout.
[in] _data: Source vertex stream from where data will be unpacked.
[in] _index: Vertex index that will be unpacked.
bgfx::vertexConvert(const VertexLayout &_destDecl, void *_destData, const VertexLayout &_srcDecl, const void *_srcData, uint32_t _num = 1)¶bgfx::vertexConvert(const VertexLayout &_destLayout, void *_destData, const VertexLayout &_srcLayout, const void *_srcData, uint32_t _num = 1)¶Converts vertex stream data from one vertex stream format to another.
C99 equivalent is bgfx_vertex_convert.
[in] _destDecl: Destination vertex stream layout.
[in] _destLayout: Destination vertex stream layout.
[in] _destData: Destination vertex stream.
[in] _srcDecl: Source vertex stream layout.
[in] _srcLayout: Source vertex stream layout.
[in] _srcData: Source vertex stream data.
[in] _num: Number of vertices to convert from source to destination.
bgfx::weldVertices(uint16_t *_output, const VertexLayout &_decl, const void *_data, uint16_t _num, float _epsilon = 0.001f)¶bgfx::weldVertices(uint16_t *_output, const VertexLayout &_layout, const void *_data, uint16_t _num, float _epsilon = 0.001f)¶Weld vertices.
Number of unique vertices after vertex welding.
@@ -2092,7 +2092,7 @@ creating windows.[in] _output: Welded vertices remapping table. The size of buffer must be the same as number of vertices.
[in] _decl: Vertex stream layout.
[in] _layout: Vertex stream layout.
[in] _data: Vertex stream.
[in] _num: Number of vertices in vertex stream.
[in] _epsilon: Error tolerance for vertex position comparison.
setVertexBuffer(uint8_t _stream, VertexBufferHandle _handle, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _declHandle = BGFX_INVALID_HANDLE)¶setVertexBuffer(uint8_t _stream, VertexBufferHandle _handle, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _layoutHandle = BGFX_INVALID_HANDLE)¶Set vertex buffer for draw primitive.
C99 equivalent is bgfx_encoder_set_vertex_buffer.
[in] _handle: Vertex buffer.
[in] _startVertex: First vertex to render.
[in] _numVertices: Number of vertices to render.
[in] _declHandle: VertexLayout handle for aliasing vertex buffer.
[in] _layoutHandle: VertexLayout handle for aliasing vertex buffer.
setVertexBuffer(uint8_t _stream, DynamicVertexBufferHandle _handle, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _declHandle = BGFX_INVALID_HANDLE)¶setVertexBuffer(uint8_t _stream, DynamicVertexBufferHandle _handle, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _layoutHandle = BGFX_INVALID_HANDLE)¶Set vertex buffer for draw primitive.
C99 equivalent is bgfx_encoder_set_dynamic_vertex_buffer.
[in] _handle: Dynamic vertex buffer.
[in] _startVertex: First vertex to render.
[in] _numVertices: Number of vertices to render.
[in] _declHandle: VertexLayout handle for aliasing vertex buffer.
[in] _layoutHandle: VertexLayout handle for aliasing vertex buffer.
setVertexBuffer(uint8_t _stream, const TransientVertexBuffer *_tvb, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _declHandle = BGFX_INVALID_HANDLE)¶setVertexBuffer(uint8_t _stream, const TransientVertexBuffer *_tvb, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _layoutHandle = BGFX_INVALID_HANDLE)¶Set vertex buffer for draw primitive.
C99 equivalent is bgfx_encoder_set_transient_vertex_buffer.
[in] _tvb: Transient vertex buffer.
[in] _startVertex: First vertex to render.
[in] _numVertices: Number of vertices to render.
[in] _declHandle: VertexLayout handle for aliasing vertex buffer.
[in] _layoutHandle: VertexLayout handle for aliasing vertex buffer.
bgfx::setVertexBuffer(uint8_t _stream, VertexBufferHandle _handle, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _declHandle = BGFX_INVALID_HANDLE)bgfx::setVertexBuffer(uint8_t _stream, VertexBufferHandle _handle, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _layoutHandle = BGFX_INVALID_HANDLE)Set vertex buffer for draw primitive.
C99 equivalent is bgfx_set_vertex_buffer.
[in] _handle: Vertex buffer.
[in] _startVertex: First vertex to render.
[in] _numVertices: Number of vertices to render.
[in] _declHandle: VertexLayout handle for aliasing vertex buffer.
[in] _layoutHandle: VertexLayout handle for aliasing vertex buffer.
bgfx::setVertexBuffer(uint8_t _stream, DynamicVertexBufferHandle _handle, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _declHandle = BGFX_INVALID_HANDLE)bgfx::setVertexBuffer(uint8_t _stream, DynamicVertexBufferHandle _handle, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _layoutHandle = BGFX_INVALID_HANDLE)Set vertex buffer for draw primitive.
C99 equivalent is bgfx_set_dynamic_vertex_buffer.
[in] _handle: Dynamic vertex buffer.
[in] _startVertex: First vertex to render.
[in] _numVertices: Number of vertices to render.
[in] _declHandle: VertexLayout handle for aliasing vertex buffer.
[in] _layoutHandle: VertexLayout handle for aliasing vertex buffer.
decl¶layoutHandle¶Vertex layout handle.
bgfx::setVertexBuffer(uint8_t _stream, const TransientVertexBuffer *_tvb, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _declHandle = BGFX_INVALID_HANDLE)bgfx::setVertexBuffer(uint8_t _stream, const TransientVertexBuffer *_tvb, uint32_t _startVertex, uint32_t _numVertices, VertexLayoutHandle _layoutHandle = BGFX_INVALID_HANDLE)Set vertex buffer for draw primitive.
C99 equivalent is bgfx_set_transient_vertex_buffer.
[in] _tvb: Transient vertex buffer.
[in] _startVertex: First vertex to render.
[in] _numVertices: Number of vertices to render.
[in] _declHandle: VertexLayout handle for aliasing vertex buffer.
[in] _layoutHandle: VertexLayout handle for aliasing vertex buffer.
bgfx::createVertexLayout(const VertexLayout &_decl)¶bgfx::createVertexLayout(const VertexLayout &_layout)¶Create vertex layout.
C99 equivalent is bgfx_create_vertex_layout.
bgfx::createVertexBuffer(const Memory *_mem, const VertexLayout &_decl, uint16_t _flags = BGFX_BUFFER_NONE)¶bgfx::createVertexBuffer(const Memory *_mem, const VertexLayout &_layout, uint16_t _flags = BGFX_BUFFER_NONE)¶Create static vertex buffer.
Static vertex buffer handle.
@@ -5168,7 +5168,7 @@ otherwise prefer bgfx::setViewScissor.[in] _mem: Vertex buffer data.
[in] _decl: Vertex layout.
[in] _layout: Vertex layout.
[in] _flags: Buffer creation flags.
BGFX_BUFFER_NONE - No flags.
BGFX_BUFFER_COMPUTE_READ - Buffer will be read from by compute shader.
VertexLayout¶Vertex layout.
C99 equivalent is bgfx_vertex_decl_t.
C99 equivalent is bgfx_vertex_layout_t.
begin(RendererType::Enum _renderer = RendererType::Noop)¶Start VertexLayout.
C99 equivalent is bgfx_vertex_decl_begin.
C99 equivalent is bgfx_vertex_layout_begin.
end()¶End VertexLayout.
C99 equivalent is bgfx_vertex_decl_end.
C99 equivalent is bgfx_vertex_layout_end.
Must be called between begin/end.
C99 equivalent is bgfx_vertex_decl_add.
C99 equivalent is bgfx_vertex_layout_add.
[in] _attrib: Attribute semantics. See: bgfx::Attrib
skip(uint8_t _num)¶Skip _num bytes in vertex stream.
C99 equivalent is bgfx_vertex_decl_skip.
C99 equivalent is bgfx_vertex_layout_skip.
decode(Attrib::Enum _attrib, uint8_t &_num, AttribType::Enum &_type, bool &_normalized, bool &_asInt) const¶Decode attribute.
C99 equivalent is bgfx_vertex_decl_decode.
C99 equivalent is bgfx_vertex_layout_decode.
has(Attrib::Enum _attrib) const¶Returns true if VertexLayout contains attribute.
C99 equivalent is bgfx_vertex_decl_has.
C99 equivalent is bgfx_vertex_layout_has.
bgfx::createDynamicVertexBuffer(uint32_t _num, const VertexLayout &_decl, uint16_t _flags = BGFX_BUFFER_NONE)bgfx::createDynamicVertexBuffer(uint32_t _num, const VertexLayout &_layout, uint16_t _flags = BGFX_BUFFER_NONE)Create empty dynamic vertex buffer.
Dynamic vertex buffer handle.
@@ -5508,7 +5508,7 @@ otherwise prefer bgfx::setViewScissor.[in] _num: Number of vertices.
[in] _decl: Vertex layout.
[in] _layout: Vertex layout.
[in] _flags: Buffer creation flags.
BGFX_BUFFER_NONE - No flags.
BGFX_BUFFER_COMPUTE_READ - Buffer will be read from by compute shader.
bgfx::createDynamicVertexBuffer(const Memory *_mem, const VertexLayout &_decl, uint16_t _flags = BGFX_BUFFER_NONE)bgfx::createDynamicVertexBuffer(const Memory *_mem, const VertexLayout &_layout, uint16_t _flags = BGFX_BUFFER_NONE)Create dynamic vertex buffer and initialize it.
Dynamic vertex buffer handle.
@@ -5535,7 +5535,7 @@ otherwise prefer bgfx::setViewScissor.[in] _mem: Vertex buffer data.
[in] _decl: Vertex layout.
[in] _layout: Vertex layout.
[in] _flags: Buffer creation flags.
BGFX_BUFFER_NONE - No flags.
BGFX_BUFFER_COMPUTE_READ - Buffer will be read from by compute shader.
bgfx::getAvailTransientVertexBuffer(uint32_t _num, const VertexLayout &_decl)¶bgfx::getAvailTransientVertexBuffer(uint32_t _num, const VertexLayout &_layout)¶Returns number of requested or maximum available vertices.
C99 equivalent is bgfx_get_avail_transient_vertex_buffer.
[in] _num: Number of required vertices.
[in] _decl: Vertex layout.
[in] _layout: Vertex layout.
bgfx::allocTransientVertexBuffer(TransientVertexBuffer *_tvb, uint32_t _num, const VertexLayout &_decl)¶bgfx::allocTransientVertexBuffer(TransientVertexBuffer *_tvb, uint32_t _num, const VertexLayout &_layout)¶Allocate transient vertex buffer.
C99 equivalent is bgfx_alloc_transient_vertex_buffer.
[out] _tvb: TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls.
[in] _num: Number of vertices to allocate.
[in] _decl: Vertex layout.
[in] _layout: Vertex layout.
OpenGL 3.1+
OpenGL ES 2
OpenGL ES 3.1
Vulkan
WebGL 1.0
WebGL 2.0