From 412dacb6330d06a709bd5932d7b118a08bd99a8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=91=D1=80=D0=B0=D0=BD=D0=B8=D0=BC=D0=B8=D1=80=20=D0=9A?= =?UTF-8?q?=D0=B0=D1=80=D0=B0=D1=9F=D0=B8=D1=9B?= Date: Tue, 25 May 2021 20:14:32 -0700 Subject: [PATCH] Updated docs. --- bgfx.html | 89 ++++++++++++++++++++++++++++++++++++++++++++----- build.html | 1 - genindex.html | 16 +++++++-- objects.inv | Bin 26708 -> 26882 bytes searchindex.js | 2 +- 5 files changed, 95 insertions(+), 13 deletions(-) diff --git a/bgfx.html b/bgfx.html index 2c9d670e9..eb2ddf97c 100644 --- a/bgfx.html +++ b/bgfx.html @@ -301,6 +301,12 @@ tutorial.

Backbuffer resolution and reset parameters. See: bgfx::Resolution.

+
+
+Limits limits
+

Configurable runtime limits.

+
+
CallbackI *callback
@@ -1127,7 +1133,7 @@ tutorial.

uint64_t supported

Supported functionality.

-
Attention

See BGFX_CAPS_* flags at https://bkaradzic.github.io/bgfx/bgfx.html#available-caps

+
Attention

See BGFX_CAPS_* flags at https://bkaradzic.github.io/bgfx/bgfx.html#available-caps

@@ -4958,6 +4964,8 @@ otherwise prefer bgfx::setViewScissor.

ShaderHandle bgfx::createShader(const Memory *_mem)

Create shader from memory buffer.

+
Return

Shader handle.

+
Attention

C99 equivalent is bgfx_create_shader.

@@ -5313,8 +5321,14 @@ otherwise prefer bgfx::setViewScissor.

VertexLayout &begin(RendererType::Enum _renderer = RendererType::Noop)

Start VertexLayout.

+
Return

Returns itself.

+
Attention

C99 equivalent is bgfx_vertex_layout_begin.

+
Parameters
+

@@ -5335,6 +5349,8 @@ otherwise prefer bgfx::setViewScissor.

VertexLayout &add(Attrib::Enum _attrib, uint8_t _num, AttribType::Enum _type, bool _normalized = false, bool _asInt = false)

Add attribute to VertexLayout.

+
Return

Returns itself.

+
Remark

Must be called between begin/end.

Attention

C99 equivalent is bgfx_vertex_layout_add.

@@ -5344,7 +5360,7 @@ otherwise prefer bgfx::setViewScissor.

  • [in] _num: Number of elements 1, 2, 3 or 4.

  • [in] _type: Element type.

  • [in] _normalized: When using fixed point AttribType (f.e. Uint8) value will be normalized for vertex shader usage. When normalized is set to true, AttribType::Uint8 value in range 0-255 will be in range 0.0-1.0 in vertex shader.

    • -

  • [in] _asInt: Packaging rule for vertexPack, vertexUnpack, and vertexConvert for AttribType::Uint8 and AttribType::Int16. Unpacking code must be implemented inside vertex shader.

    • +

  • [in] _asInt: Packaging rule for vertexPack, vertexUnpack, and vertexConvert for AttribType::Uint8 and AttribType::Int16. Unpacking code must be implemented inside vertex shader.

    • @@ -5356,6 +5372,8 @@ otherwise prefer bgfx::setViewScissor.

    VertexLayout &skip(uint8_t _num)

    Skip _num bytes in vertex stream.

    +
    Return

    Returns itself.

    +
    Attention

    C99 equivalent is bgfx_vertex_layout_skip.

    @@ -5376,10 +5394,16 @@ otherwise prefer bgfx::setViewScissor.

    bool has(Attrib::Enum _attrib) const
    -

    Returns true if VertexLayout contains attribute.

    +

    Returns true if VertexLayout contains attribute.

    +
    Return

    True if VertexLayout contains attribute.

    +
    Attention

    C99 equivalent is bgfx_vertex_layout_has.

    +
    Parameters
    +

    @@ -5388,18 +5412,68 @@ otherwise prefer bgfx::setViewScissor.

    uint16_t getOffset(Attrib::Enum _attrib) const

    Returns relative attribute offset from the vertex.

    +

    +
    Return

    Relative attribute offset from the vertex.

    +
    +
    Parameters
    +
    +
    +

    uint16_t getStride() const

    Returns vertex stride.

    +

    +
    Return

    Vertex stride.

    +
    +
    +

    uint32_t getSize(uint32_t _num) const

    Returns size of vertex buffer for number of vertices.

    +

    +
    Return

    Size of vertex buffer for number of vertices.

    +
    +
    Parameters
      +

    • [in] _num: Number of vertices.

      • +
    +
    +
    +

    +
    + + +
    +

    Public Members

    +
    +
    +uint32_t m_hash
    +

    Hash.

    +
    + +
    +
    +uint16_t m_stride
    +

    Stride.

    +
    + +
    +
    +uint16_t m_offset[Count]
    +

    Attribute offsets.

    +
    + +
    +
    +uint16_t m_attributes[Count]
    +

    Used attributes.

    @@ -5858,14 +5932,15 @@ otherwise prefer bgfx::setViewScissor.

    -
    -uint32_t bgfx::getAvailTransientIndexBuffer(uint32_t _num)
    +
    +uint32_t bgfx::getAvailTransientIndexBuffer(uint32_t _num, bool _index32 = false)

    Returns number of requested or maximum available indices.

    Attention

    C99 equivalent is bgfx_get_avail_transient_index_buffer.

    Parameters
      -

    • [in] _num: Number of required indices.

      • +

    • [in] _num: Number of required indices.

      • +

    • [in] _index32: Set to true if input indices will be 32-bit.

    @@ -5877,8 +5952,6 @@ otherwise prefer bgfx::setViewScissor.

    void bgfx::allocTransientIndexBuffer(TransientIndexBuffer *_tib, uint32_t _num, bool _index32 = false)

    Allocate transient index buffer.

    -
    Remark

    Only 16-bit index buffer is supported.

    -
    Attention

    C99 equivalent is bgfx_alloc_transient_index_buffer.

    Parameters