Files
bgfx/src/bgfx_p.h
T

8640 lines
227 KiB
C++

/*
* Copyright 2011-2026 Branimir Karadzic. All rights reserved.
* License: https://github.com/bkaradzic/bgfx/blob/master/LICENSE
*/
#ifndef BGFX_P_H_HEADER_GUARD
#define BGFX_P_H_HEADER_GUARD
#include <bx/platform.h>
#ifndef BX_CONFIG_DEBUG
# error "BX_CONFIG_DEBUG must be defined in build script!"
#endif // BX_CONFIG_DEBUG
#define BGFX_CONFIG_DEBUG BX_CONFIG_DEBUG
#if BX_CONFIG_DEBUG
# define BX_TRACE _BGFX_TRACE
# define BX_WARN _BGFX_WARN
# define BX_ASSERT _BGFX_ASSERT
#endif // BX_CONFIG_DEBUG
#include <bgfx/bgfx.h>
#include "config.h"
#include <inttypes.h>
// Check handle, cannot be bgfx::kInvalidHandle and must be valid.
#define BGFX_CHECK_HANDLE(_desc, _handleAlloc, _handle) \
BX_ASSERT(isValid(_handle) \
&& _handleAlloc.isValid(_handle.idx) \
, "Invalid handle. %s handle: %d (max %d)" \
, _desc \
, _handle.idx \
, _handleAlloc.getMaxHandles() \
)
// Check handle, it's ok to be bgfx::kInvalidHandle or must be valid.
#define BGFX_CHECK_HANDLE_INVALID_OK(_desc, _handleAlloc, _handle) \
BX_ASSERT(!isValid(_handle) \
|| _handleAlloc.isValid(_handle.idx) \
, "Invalid handle. %s handle: %d (max %d)" \
, _desc \
, _handle.idx \
, _handleAlloc.getMaxHandles() \
)
#if BGFX_CONFIG_MULTITHREADED
# define BGFX_MUTEX_SCOPE(_mutex) bx::MutexScope BX_CONCATENATE(mutexScope, __LINE__)(_mutex)
#else
# define BGFX_MUTEX_SCOPE(_mutex) BX_NOOP()
#endif // BGFX_CONFIG_MULTITHREADED
#if BGFX_CONFIG_PROFILER
# define BGFX_PROFILER_SCOPE(_name, _abgr) ProfilerScope BX_CONCATENATE(profilerScope, __LINE__)(_name, _abgr, __FILE__, uint16_t(__LINE__) )
# define BGFX_PROFILER_BEGIN(_name, _abgr) g_callback->profilerBegin(_name, _abgr, __FILE__, uint16_t(__LINE__) )
# define BGFX_PROFILER_BEGIN_LITERAL(_name, _abgr) g_callback->profilerBeginLiteral(_name, _abgr, __FILE__, uint16_t(__LINE__) )
# define BGFX_PROFILER_END() g_callback->profilerEnd()
# define BGFX_PROFILER_SET_CURRENT_THREAD_NAME(_name) BX_NOOP()
#else
# define BGFX_PROFILER_SCOPE(_name, _abgr) BX_NOOP()
# define BGFX_PROFILER_BEGIN(_name, _abgr) BX_NOOP()
# define BGFX_PROFILER_BEGIN_LITERAL(_name, _abgr) BX_NOOP()
# define BGFX_PROFILER_END() BX_NOOP()
# define BGFX_PROFILER_SET_CURRENT_THREAD_NAME(_name) BX_NOOP()
#endif // BGFX_PROFILER_SCOPE
namespace bgfx
{
#if BX_COMPILER_CLANG_ANALYZER
void __attribute__( (analyzer_noreturn) ) fatal(const char* _filePath, uint16_t _line, Fatal::Enum _code, const char* _format, ...);
#else
void fatal(const char* _filePath, uint16_t _line, Fatal::Enum _code, const char* _format, ...);
#endif // BX_COMPILER_CLANG_ANALYZER
void trace(const char* _filePath, uint16_t _line, const char* _format, ...);
inline bool operator==(const VertexLayoutHandle& _lhs, const VertexLayoutHandle& _rhs) { return _lhs.idx == _rhs.idx; }
inline bool operator==(const UniformHandle& _lhs, const UniformHandle& _rhs) { return _lhs.idx == _rhs.idx; }
}
#define _BGFX_TRACE(_format, ...) \
BX_MACRO_BLOCK_BEGIN \
bgfx::trace(__FILE__, uint16_t(__LINE__), "BGFX " _format "\n", ##__VA_ARGS__); \
BX_MACRO_BLOCK_END
#define _BGFX_WARN(_condition, _format, ...) \
BX_MACRO_BLOCK_BEGIN \
if (!BX_IGNORE_C4127(_condition) ) \
{ \
BX_TRACE("WARN " _format, ##__VA_ARGS__); \
} \
BX_MACRO_BLOCK_END
#define _BGFX_ASSERT(_condition, _format, ...) \
BX_MACRO_BLOCK_BEGIN \
if (!BX_IGNORE_C4127(_condition) \
&& bx::assertFunction(bx::Location::current(), 0, "ASSERT " #_condition " -> " _format, ##__VA_ARGS__) ) \
{ \
bgfx::fatal(__FILE__, uint16_t(__LINE__), bgfx::Fatal::DebugCheck, _format, ##__VA_ARGS__); \
} \
BX_MACRO_BLOCK_END
#define BGFX_FATAL(_condition, _err, _format, ...) \
BX_MACRO_BLOCK_BEGIN \
if (!BX_IGNORE_C4127(_condition) ) \
{ \
fatal(__FILE__, uint16_t(__LINE__), _err, _format, ##__VA_ARGS__); \
} \
BX_MACRO_BLOCK_END
#define BGFX_ERROR_CHECK(_condition, _err, _result, _msg, _format, ...) \
if (!BX_IGNORE_C4127(_condition) ) \
{ \
BX_ERROR_SET(_err, _result, _msg); \
BX_TRACE("%S: 0x%08x '%S' - " _format \
, &bxErrorScope.getName() \
, _err->get().code \
, &_err->getMessage() \
, ##__VA_ARGS__ \
); \
return; \
}
#include <bx/allocator.h>
#include <bx/bx.h>
#include <bx/cpu.h>
#include <bx/debug.h>
#include <bx/endian.h>
#include <bx/error.h>
#include <bx/float4x4_t.h>
#include <bx/handlealloc.h>
#include <bx/hash.h>
#include <bx/math.h>
#include <bx/mutex.h>
#include <bx/os.h>
#include <bx/readerwriter.h>
#include <bx/ringbuffer.h>
#include <bx/sort.h>
#include <bx/string.h>
#include <bx/thread.h>
#include <bx/timer.h>
#include <bimg/bimg.h>
#include "shader.h"
#include "vertexlayout.h"
#include "version.h"
#define BGFX_CLEAR_COLOR_USE_PALETTE UINT16_C(0x8000)
#define BGFX_CLEAR_MASK (0 \
| BGFX_CLEAR_COLOR \
| BGFX_CLEAR_DEPTH \
| BGFX_CLEAR_STENCIL \
| BGFX_CLEAR_COLOR_USE_PALETTE \
)
namespace bgfx
{
struct TinyStlAllocator
{
static void* static_allocate(size_t _bytes);
static void static_deallocate(void* _ptr, size_t /*_bytes*/);
};
} // namespace bgfx
#define TINYSTL_ALLOCATOR bgfx::TinyStlAllocator
#include <tinystl/string.h>
#include <tinystl/unordered_map.h>
#include <tinystl/unordered_set.h>
#include <tinystl/vector.h>
namespace tinystl
{
template<typename T, typename Alloc = TINYSTL_ALLOCATOR>
class list : public vector<T, Alloc>
{
public:
void push_front(const T& _value)
{
this->insert(this->begin(), _value);
}
void pop_front()
{
this->erase(this->begin() );
}
void sort()
{
bx::quickSort(
this->begin()
, uint32_t(this->end() - this->begin() )
, sizeof(T)
, [](const void* _a, const void* _b) -> int32_t {
const T& lhs = *(const T*)(_a);
const T& rhs = *(const T*)(_b);
return lhs < rhs ? -1 : 1;
});
}
};
} // namespace tinystl
namespace stl = tinystl;
#if BX_PLATFORM_ANDROID
# include <android/native_window.h>
#endif // BX_PLATFORM_*
#define BGFX_MAX_COMPUTE_BINDINGS BGFX_CONFIG_MAX_TEXTURE_SAMPLERS
#define BGFX_SAMPLER_INTERNAL_DEFAULT UINT32_C(0x10000000)
#define BGFX_SAMPLER_INTERNAL_SHARED UINT32_C(0x20000000)
#define BGFX_TEXTURE_INTERNAL_VIDEO_DECODE_DST UINT64_C(0x1000000000000000)
#define BGFX_RESET_INTERNAL_FORCE UINT32_C(0x80000000)
#define BGFX_STATE_INTERNAL_SCISSOR UINT64_C(0x2000000000000000)
#define BGFX_STATE_INTERNAL_OCCLUSION_QUERY UINT64_C(0x4000000000000000)
#define BGFX_SUBMIT_INTERNAL_NONE UINT8_C(0x00)
#define BGFX_SUBMIT_INTERNAL_INDEX32 UINT8_C(0x40)
#define BGFX_SUBMIT_INTERNAL_OCCLUSION_VISIBLE UINT8_C(0x80)
#define BGFX_SUBMIT_INTERNAL_RESERVED_MASK UINT8_C(0xff)
#define BGFX_RENDERER_NOOP_NAME "Noop"
#define BGFX_RENDERER_AGC_NAME "AGC"
#define BGFX_RENDERER_DIRECT3D11_NAME "Direct3D 11"
#define BGFX_RENDERER_DIRECT3D12_NAME "Direct3D 12"
#define BGFX_RENDERER_GNM_NAME "GNM"
#define BGFX_RENDERER_METAL_NAME "Metal"
#define BGFX_RENDERER_NVN_NAME "NVN"
#define BGFX_RENDERER_VULKAN_NAME "Vulkan"
#define BGFX_RENDERER_WEBGPU_NAME "WebGPU"
#if BGFX_CONFIG_RENDERER_OPENGL
# if BGFX_CONFIG_RENDERER_OPENGL == 43
# define BGFX_RENDERER_OPENGL_NAME "OpenGL 4.3"
# elif BGFX_CONFIG_RENDERER_OPENGL == 44
# define BGFX_RENDERER_OPENGL_NAME "OpenGL 4.4"
# elif BGFX_CONFIG_RENDERER_OPENGL == 45
# define BGFX_RENDERER_OPENGL_NAME "OpenGL 4.5"
# else
# define BGFX_RENDERER_OPENGL_NAME "OpenGL 4.6"
# endif // BGFX_CONFIG_RENDERER_OPENGL
#elif BGFX_CONFIG_RENDERER_OPENGLES
# if BGFX_CONFIG_RENDERER_OPENGLES == 30
# define BGFX_RENDERER_OPENGL_NAME "OpenGL ES 3.0"
# elif BGFX_CONFIG_RENDERER_OPENGLES == 31
# define BGFX_RENDERER_OPENGL_NAME "OpenGL ES 3.1"
# else
# define BGFX_RENDERER_OPENGL_NAME "OpenGL ES 3.2"
# endif // BGFX_CONFIG_RENDERER_OPENGLES
#else
# define BGFX_RENDERER_OPENGL_NAME "OpenGL"
#endif //
namespace bgfx
{
static constexpr uint32_t kChunkMagicTex = BX_MAKEFOURCC('T', 'E', 'X', 0x0);
static constexpr uint32_t kVideoDecoderInitMagic = BX_MAKEFOURCC('V', 'D', 'I', 0x0);
static constexpr uint32_t kVideoDecoderFrameMagic = BX_MAKEFOURCC('V', 'D', 'F', 0x0);
static constexpr uint32_t kSwapChainFlagMask = 0
| BGFX_SWAP_CHAIN_FULLSCREEN
| BGFX_SWAP_CHAIN_MSAA_MASK
| BGFX_SWAP_CHAIN_SRGB_BACKBUFFER
| BGFX_SWAP_CHAIN_HDR10
| BGFX_SWAP_CHAIN_HIDPI
| BGFX_SWAP_CHAIN_TRANSPARENT_BACKBUFFER
;
// Palette:
// https://colorkit.co/color-palette-generator/a8e6cf-dcedc1-ffd3b6-76b4bd-bdeaee-8874a3-ff0000-ff8b94/
static constexpr uint32_t kColorFrame = 0xa8'e6'cf'ff;
static constexpr uint32_t kColorSubmit = 0xdc'ed'c1'ff;
static constexpr uint32_t kColorView = 0xff'd3'b6'ff;
static constexpr uint32_t kColorDraw = 0x76'b4'bd'ff;
static constexpr uint32_t kColorCompute = 0xbd'ea'ee'ff;
static constexpr uint32_t kColorResource = 0x88'74'a3'ff;
static constexpr uint32_t kColorMarker = 0xff'00'00'ff;
static constexpr uint32_t kColorWait = 0xff'8b'94'ff;
extern InternalData g_internalData;
extern PlatformData g_platformData;
extern void isFrameBufferValid(uint8_t _num, const Attachment* _attachment, bx::Error* _err);
extern void isIdentifierValid(const bx::StringView& _name, bx::Error* _err);
#if BGFX_CONFIG_MAX_DRAW_CALLS < (64<<10)
typedef uint16_t RenderItemCount;
#else
typedef uint32_t RenderItemCount;
#endif // BGFX_CONFIG_MAX_DRAW_CALLS < (64<<10)
static constexpr uint32_t kBlitBlock = BGFX_CONFIG_BLIT_BLOCK;
static constexpr uint32_t kDepthControlBlock = BGFX_CONFIG_DEPTH_CONTROL_BLOCK;
static constexpr uint32_t kDrawCallBlock = BGFX_CONFIG_DRAW_CALL_BLOCK;
static constexpr uint32_t kMatrixBlock = BGFX_CONFIG_MATRIX_BLOCK;
static constexpr uint32_t kRectBlock = BGFX_CONFIG_RECT_BLOCK;
static constexpr uint32_t kViewBlock = BGFX_CONFIG_VIEW_BLOCK;
static constexpr uint32_t kViewUsedWords = bx::alignUp(BGFX_CONFIG_MAX_VIEWS, 64)/64;
inline uint32_t alignDrawCalls(uint32_t _num)
{
return _num >= BGFX_CONFIG_MAX_DRAW_CALLS
? uint32_t(BGFX_CONFIG_MAX_DRAW_CALLS)
: bx::min<uint32_t>(BGFX_CONFIG_MAX_DRAW_CALLS, uint32_t(bx::alignUp(_num, kDrawCallBlock) ) )
;
}
///
struct Handle
{
///
struct TypeName
{
const char* abrvName;
const char* fullName;
};
///
enum Enum
{
DynamicIndexBuffer,
DynamicVertexBuffer,
FrameBuffer,
IndexBuffer,
IndirectBuffer,
OcclusionQuery,
Program,
Shader,
Texture,
Uniform,
VertexBuffer,
VertexLayout,
Count
};
template<typename Ty>
static constexpr Enum toEnum();
constexpr Handle()
: idx(kInvalidHandle)
, type(Count)
{
}
template<typename Ty>
constexpr Handle(Ty _handle)
: idx(_handle.idx)
, type(uint16_t(toEnum<Ty>() ) )
{
}
template<typename Ty>
constexpr Ty to() const
{
if (type == toEnum<Ty>() )
{
return Ty{ idx };
}
BX_ASSERT(type == toEnum<Ty>(), "Handle type %s, cannot be converted to %s."
, getTypeName().fullName
, getTypeName(toEnum<Ty>() ).fullName
);
return { kInvalidHandle };
}
Enum getType() const
{
return Enum(type);
}
static const TypeName& getTypeName(Handle::Enum _enum);
const TypeName& getTypeName() const
{
return getTypeName(getType() );
}
bool isTexture() const
{
return type == Texture;
}
bool isBuffer() const
{
return false
|| isIndexBuffer()
|| isVertexBuffer()
;
}
bool isIndexBuffer() const
{
return false
|| type == IndexBuffer
|| type == DynamicIndexBuffer
;
}
bool isVertexBuffer() const
{
return false
|| type == VertexBuffer
|| type == DynamicVertexBuffer
|| type == IndirectBuffer
;
}
uint16_t idx;
uint16_t type;
};
#define IMPLEMENT_HANDLE(_name) \
template<> \
inline constexpr Handle::Enum Handle::toEnum<_name##Handle>() \
{ \
return Handle::_name; \
} \
IMPLEMENT_HANDLE(DynamicIndexBuffer);
IMPLEMENT_HANDLE(DynamicVertexBuffer);
IMPLEMENT_HANDLE(FrameBuffer);
IMPLEMENT_HANDLE(IndexBuffer);
IMPLEMENT_HANDLE(IndirectBuffer);
IMPLEMENT_HANDLE(OcclusionQuery);
IMPLEMENT_HANDLE(Program);
IMPLEMENT_HANDLE(Shader);
IMPLEMENT_HANDLE(Texture);
IMPLEMENT_HANDLE(Uniform);
IMPLEMENT_HANDLE(VertexBuffer);
IMPLEMENT_HANDLE(VertexLayout);
#undef IMPLEMENT_HANDLE
inline bool isValid(const VertexLayout& _layout)
{
return 0 != _layout.m_stride;
}
struct Condition
{
enum Enum
{
LessEqual,
GreaterEqual,
};
};
void* findModule(const char* _name);
bool windowsVersionIs(Condition::Enum _op, uint32_t _version, uint32_t _build = UINT32_MAX);
static constexpr bool isShaderType(uint32_t _magic, char _type)
{
return uint32_t(_type) == (_magic & BX_MAKEFOURCC(0xff, 0, 0, 0) );
}
inline bool isShaderBin(uint32_t _magic)
{
return BX_MAKEFOURCC(0, 'S', 'H', 0) == (_magic & BX_MAKEFOURCC(0, 0xff, 0xff, 0) )
&& (isShaderType(_magic, 'C') || isShaderType(_magic, 'F') || isShaderType(_magic, 'V') )
;
}
inline bool isShaderVerLess(uint32_t _magic, uint8_t _version)
{
return (_magic & BX_MAKEFOURCC(0, 0, 0, 0xff) ) < BX_MAKEFOURCC(0, 0, 0, _version);
}
inline bool hasReadOnlyDepth(const Attachment* _attachment, uint8_t _num)
{
for (uint8_t ii = 0; ii < _num; ++ii)
{
if (0 != (_attachment[ii].flags & BGFX_ATTACHMENT_READ_ONLY_DEPTH) )
{
return true;
}
}
return false;
}
inline bool hasReadOnlyStencil(const Attachment* _attachment, uint8_t _num)
{
for (uint8_t ii = 0; ii < _num; ++ii)
{
if (0 != (_attachment[ii].flags & BGFX_ATTACHMENT_READ_ONLY_STENCIL) )
{
return true;
}
}
return false;
}
inline uint64_t getAttachmentStateMask(const Attachment* _attachment, uint8_t _num)
{
return hasReadOnlyDepth(_attachment, _num)
? ~BGFX_STATE_WRITE_Z
: UINT64_MAX
;
}
inline uint64_t getAttachmentStencilMask(const Attachment* _attachment, uint8_t _num)
{
return hasReadOnlyStencil(_attachment, _num)
? ~(uint64_t(BGFX_STENCIL_FUNC_RMASK_MASK)<<32)
: UINT64_MAX
;
}
inline void readRawBindings(bx::ReaderI* _reader, uint32_t& _srvMask, uint32_t& _uavMask, bx::Error* _err)
{
bx::read(_reader, _srvMask, _err);
bx::read(_reader, _uavMask, _err);
}
const char* getShaderTypeName(uint32_t _magic);
struct Clear
{
void set(uint16_t _flags, uint32_t _rgba, float _depth, uint8_t _stencil)
{
m_flags = _flags;
m_index[0] = uint8_t(_rgba>>24);
m_index[1] = uint8_t(_rgba>>16);
m_index[2] = uint8_t(_rgba>> 8);
m_index[3] = uint8_t(_rgba>> 0);
m_depth = _depth;
m_stencil = _stencil;
}
void set(uint16_t _flags, float _depth, uint8_t _stencil, uint8_t _0, uint8_t _1, uint8_t _2, uint8_t _3, uint8_t _4, uint8_t _5, uint8_t _6, uint8_t _7)
{
m_flags = (_flags & ~BGFX_CLEAR_COLOR)
| (0xff != (_0&_1&_2&_3&_4&_5&_6&_7) ? BGFX_CLEAR_COLOR|BGFX_CLEAR_COLOR_USE_PALETTE : 0)
;
m_index[0] = _0;
m_index[1] = _1;
m_index[2] = _2;
m_index[3] = _3;
m_index[4] = _4;
m_index[5] = _5;
m_index[6] = _6;
m_index[7] = _7;
m_depth = _depth;
m_stencil = _stencil;
}
uint8_t getColorSkipMask(uint32_t _num) const
{
if (0 == (m_flags & BGFX_CLEAR_COLOR_USE_PALETTE) )
{
return 0;
}
uint8_t mask = 0;
for (uint32_t ii = 0, num = bx::min<uint32_t>(_num, BX_COUNTOF(m_index) ); ii < num; ++ii)
{
mask |= UINT8_MAX == m_index[ii] ? 1<<ii : 0;
}
return mask;
}
uint8_t m_index[8];
float m_depth;
uint8_t m_stencil;
uint16_t m_flags;
};
BX_ALIGN_DECL(8, struct) Rect
{
Rect()
{
}
Rect(int16_t _x, int16_t _y, uint16_t _width, uint16_t _height)
: m_x(_x)
, m_y(_y)
, m_width(_width)
, m_height(_height)
{
}
void clear()
{
m_x = 0;
m_y = 0;
m_width = 0;
m_height = 0;
}
bool isZero() const
{
static_assert(8 == sizeof(Rect), "");
uint64_t ui64 = *( (uint64_t*)this);
return UINT64_C(0) == ui64;
}
bool isZeroArea() const
{
return false
|| 0 == m_width
|| 0 == m_height
;
}
bool isEqual(const Rect& _other) const
{
return true
&& m_x == _other.m_x
&& m_y == _other.m_y
&& m_width == _other.m_width
&& m_height == _other.m_height
;
}
void set(int16_t _x, int16_t _y, uint16_t _width, uint16_t _height)
{
m_x = _x;
m_y = _y;
m_width = _width;
m_height = _height;
}
void setIntersect(const Rect& _a, const Rect& _b)
{
const int32_t sx = bx::max<int32_t>(_a.m_x, _b.m_x);
const int32_t sy = bx::max<int32_t>(_a.m_y, _b.m_y);
const int32_t ex = bx::min<int32_t>(_a.m_x + _a.m_width, _b.m_x + _b.m_width );
const int32_t ey = bx::min<int32_t>(_a.m_y + _a.m_height, _b.m_y + _b.m_height);
m_x = int16_t(sx);
m_y = int16_t(sy);
m_width = uint16_t(bx::max<int32_t>(ex - sx, 0) );
m_height = uint16_t(bx::max<int32_t>(ey - sy, 0) );
}
void intersect(const Rect& _a)
{
setIntersect(*this, _a);
}
int16_t m_x;
int16_t m_y;
uint16_t m_width;
uint16_t m_height;
};
struct TextureCreate
{
TextureFormat::Enum m_format;
uint16_t m_width;
uint16_t m_height;
uint16_t m_depth;
uint16_t m_numLayers;
uint8_t m_numMips;
bool m_cubeMap;
const Memory* m_mem;
};
extern const uint32_t g_uniformTypeSize[UniformType::Count+1];
extern CallbackI* g_callback;
extern bx::AllocatorI* g_allocator;
extern Caps g_caps;
struct Frame;
void formatViewName(char* _out, const Frame* _frame, ViewId _view, const bx::StringView& _type);
const char* getViewName(const Frame* _frame, ViewId _view);
struct ProfilerScope
{
ProfilerScope(const char* _name, uint32_t _abgr, const char* _filePath, uint16_t _line)
{
g_callback->profilerBeginLiteral(_name, _abgr, _filePath, _line);
}
~ProfilerScope()
{
g_callback->profilerEnd();
}
};
using bimg::isVolume;
void setGraphicsDebuggerPresent(bool _present);
bool isGraphicsDebuggerPresent();
void release(const Memory* _mem);
const char* getAttribName(Attrib::Enum _attr);
const char* getAttribNameShort(Attrib::Enum _attr);
void getTextureSizeFromRatio(BackbufferRatio::Enum _ratio, uint16_t& _width, uint16_t& _height);
TextureFormat::Enum getViableTextureFormat(const bimg::ImageContainer& _imageContainer);
const char* getName(TextureFormat::Enum _fmt);
const char* getName(UniformHandle _handle);
const char* getName(ShaderHandle _handle);
const char* getName(Topology::Enum _topology);
const struct UniformRef& getUniformRef(UniformHandle _handle);
template<typename Ty>
inline void release(Ty)
{
}
template<>
inline void release(Memory* _mem)
{
release( (const Memory*)_mem);
}
static constexpr uint32_t kTextureZeroInitBudget = 64<<10;
inline constexpr uint32_t textureZeroInitTileDim(uint32_t _bpp, uint32_t _budget = kTextureZeroInitBudget)
{
uint32_t dim = 512;
while (dim > 1
&& uint64_t(dim)*dim*_bpp/8 > _budget)
{
dim >>= 1;
}
return dim;
}
static_assert(BGFX_STENCIL_NONE == BGFX_STENCIL_FUNC_RMASK_MASK, "");
inline constexpr uint64_t packStencil(uint32_t _fstencil, uint32_t _bstencil)
{
return (uint64_t(_bstencil)<<32)|uint64_t(_fstencil);
}
inline constexpr uint32_t unpackStencil(uint8_t _0or1, uint64_t _stencil)
{
return uint32_t( (_stencil >> (32*_0or1) ) );
}
inline constexpr uint8_t unpackStencilWriteMask(uint64_t _stencil)
{
return uint8_t( (unpackStencil(1, _stencil) & BGFX_STENCIL_FUNC_RMASK_MASK) >> BGFX_STENCIL_FUNC_RMASK_SHIFT);
}
inline constexpr bool stencilFrontAndBack(uint64_t _stencil)
{
const uint32_t fstencil = unpackStencil(0, _stencil) & ~BGFX_STENCIL_FUNC_RMASK_MASK;
const uint32_t bstencil = unpackStencil(1, _stencil) & ~BGFX_STENCIL_FUNC_RMASK_MASK;
return bstencil != (BGFX_STENCIL_NONE & ~BGFX_STENCIL_FUNC_RMASK_MASK)
&& bstencil != fstencil;
}
static constexpr uint64_t kStencilNoRefMask = packStencil(~BGFX_STENCIL_FUNC_REF_MASK, ~BGFX_STENCIL_FUNC_REF_MASK);
static constexpr uint64_t kStencilNoRefAndRwMask = packStencil(~(BGFX_STENCIL_FUNC_REF_MASK|BGFX_STENCIL_FUNC_RMASK_MASK), ~(BGFX_STENCIL_FUNC_REF_MASK|BGFX_STENCIL_FUNC_RMASK_MASK));
static constexpr uint64_t kStencilDisabled = packStencil(
BGFX_STENCIL_TEST_ALWAYS | BGFX_STENCIL_OP_FAIL_S_KEEP | BGFX_STENCIL_OP_FAIL_Z_KEEP | BGFX_STENCIL_OP_PASS_Z_KEEP
, BGFX_STENCIL_TEST_ALWAYS | BGFX_STENCIL_OP_FAIL_S_KEEP | BGFX_STENCIL_OP_FAIL_Z_KEEP | BGFX_STENCIL_OP_PASS_Z_KEEP
);
inline constexpr bool stencilEnabled(uint64_t _stencil)
{
return 0 != (_stencil & kStencilNoRefAndRwMask);
}
inline constexpr bool needBorderColor(uint64_t _flags)
{
return BGFX_SAMPLER_U_BORDER == (_flags & BGFX_SAMPLER_U_BORDER)
|| BGFX_SAMPLER_V_BORDER == (_flags & BGFX_SAMPLER_V_BORDER)
|| BGFX_SAMPLER_W_BORDER == (_flags & BGFX_SAMPLER_W_BORDER)
;
}
inline constexpr uint8_t calcNumMips(bool _hasMips, uint16_t _width, uint16_t _height, uint16_t _depth = 1)
{
if (_hasMips)
{
const uint32_t max = bx::max(_width, _height, _depth);
const uint32_t num = 1 + bx::floorLog2(max);
return uint8_t(num);
}
return 1;
}
inline constexpr uint8_t calcNumMips(uint64_t _flags, bool _hasMips, uint16_t _width, uint16_t _height, uint16_t _depth = 1)
{
const uint8_t requested = uint8_t( (_flags & BGFX_TEXTURE_MIP_COUNT_MASK) >> BGFX_TEXTURE_MIP_COUNT_SHIFT);
if (0 == requested)
{
return calcNumMips(_hasMips, _width, _height, _depth);
}
return bx::min(requested, calcNumMips(true, _width, _height, _depth) );
}
/// Dump vertex layout info into debug output.
void dump(const VertexLayout& _layout);
/// Dump resolution and reset info into debug output.
void dump(const SwapChain& _swapChain, uint32_t _reset);
struct TextVideoMem
{
TextVideoMem()
: m_mem(NULL)
, m_size(0)
, m_width(0)
, m_height(0)
, m_small(false)
{
resize(false, 1, 1);
clear();
}
~TextVideoMem()
{
bx::free(g_allocator, m_mem);
}
void resize(bool _small, uint32_t _width, uint32_t _height)
{
uint32_t width = bx::max(1u, _width/8);
uint32_t height = bx::max(1u, _height/(_small ? 8u : 16u) );
if (NULL == m_mem
|| m_width != width
|| m_height != height
|| m_small != _small)
{
m_small = _small;
m_width = bx::narrowCast<uint16_t>(width);
m_height = bx::narrowCast<uint16_t>(height);
uint32_t size = m_size;
m_size = m_width * m_height;
m_mem = (MemSlot*)bx::realloc(g_allocator, m_mem, m_size * sizeof(MemSlot) );
if (size < m_size)
{
bx::memSet(&m_mem[size], 0, (m_size-size) * sizeof(MemSlot) );
}
}
}
void clear(uint8_t _attr = 0)
{
MemSlot* mem = m_mem;
bx::memSet(mem, 0, m_size * sizeof(MemSlot) );
if (_attr != 0)
{
for (uint32_t ii = 0, num = m_size; ii < num; ++ii)
{
mem[ii].attribute = _attr;
}
}
}
void printfVargs(uint16_t _x, uint16_t _y, uint8_t _attr, const char* _format, va_list _argList);
void printf(uint16_t _x, uint16_t _y, uint8_t _attr, const char* _format, ...)
{
va_list argList;
va_start(argList, _format);
printfVargs(_x, _y, _attr, _format, argList);
va_end(argList);
}
void image(uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height, const void* _data, uint16_t _pitch)
{
if (_x < m_width && _y < m_height)
{
MemSlot* dst = &m_mem[_y*m_width+_x];
const uint8_t* src = (const uint8_t*)_data;
const uint32_t width = bx::min<uint32_t>(m_width, _width +_x)-_x;
const uint32_t height = bx::min<uint32_t>(m_height, _height+_y)-_y;
const uint32_t dstPitch = m_width;
for (uint32_t ii = 0; ii < height; ++ii)
{
for (uint32_t jj = 0; jj < width; ++jj)
{
dst[jj].character = src[jj*2];
dst[jj].attribute = src[jj*2+1];
}
src += _pitch;
dst += dstPitch;
}
}
}
struct MemSlot
{
uint8_t attribute;
uint8_t character;
};
MemSlot* m_mem;
uint32_t m_size;
uint16_t m_width;
uint16_t m_height;
bool m_small;
};
struct TextVideoMemBlitter
{
void init();
void shutdown();
TextureHandle m_texture;
TransientVertexBuffer* m_vb;
TransientIndexBuffer* m_ib;
VertexLayout m_layout;
ProgramHandle m_program;
uintptr_t m_usedData;
};
struct RendererContextI;
extern void dbgTextSubmit(RendererContextI* _renderCtx, TextVideoMemBlitter& _blitter, const TextVideoMem& _mem, FrameBufferHandle _handle, uint8_t _scale);
inline void dbgTextSubmit(RendererContextI* _renderCtx, TextVideoMemBlitter& _blitter, const TextVideoMem* _mem, FrameBufferHandle _handle, uint8_t _scale)
{
if (NULL != _mem)
{
dbgTextSubmit(_renderCtx, _blitter, *_mem, _handle, _scale);
}
}
template <uint32_t maxKeys>
struct UpdateBatchT
{
UpdateBatchT()
: m_num(0)
{
}
void add(uint32_t _key, uint32_t _value)
{
const uint32_t num = m_num++;
m_keys [num] = _key;
m_values[num] = _value;
}
bool sort()
{
if (0 < m_num)
{
uint32_t* tempKeys = (uint32_t*)BX_STACK_ALLOC(sizeof(m_keys) );
uint32_t* tempValues = (uint32_t*)BX_STACK_ALLOC(sizeof(m_values) );
bx::radixSort(m_keys, tempKeys, m_values, tempValues, m_num);
return true;
}
return false;
}
bool isFull() const
{
return m_num >= maxKeys;
}
void reset()
{
m_num = 0;
}
uint32_t m_num;
uint32_t m_keys[maxKeys];
uint32_t m_values[maxKeys];
};
template<typename MaskT>
struct BitMaskToIndexIteratorT
{
BitMaskToIndexIteratorT(MaskT _mask)
: mask(0)
, idx(0)
{
const uint8_t ntz = bx::countTrailingZeros<MaskT>(_mask);
mask = 0 == _mask ? MaskT(0) : MaskT(_mask >> ntz);
idx = ntz;
}
void next()
{
mask = MaskT(mask >> 1);
idx += 1;
const uint8_t ntz = bx::countTrailingZeros<MaskT>(mask);
mask = 0 == mask ? MaskT(0) : MaskT(mask >> ntz);
idx += ntz;
}
bool isDone() const
{
return 0 == mask;
}
MaskT mask;
uint8_t idx;
};
struct ClearQuad
{
ClearQuad()
: m_vb(BGFX_INVALID_HANDLE)
, m_layout(BGFX_INVALID_HANDLE)
{
for (uint32_t ii = 0; ii < BX_COUNTOF(m_program); ++ii)
{
m_program[ii] = BGFX_INVALID_HANDLE;
}
}
void init();
void shutdown();
VertexBufferHandle m_vb;
VertexLayoutHandle m_layout;
ProgramHandle m_program[BGFX_CONFIG_MAX_FRAME_BUFFER_ATTACHMENTS];
};
struct MipGen
{
MipGen()
: u_mipGen(BGFX_INVALID_HANDLE)
, s_texMipSrc(BGFX_INVALID_HANDLE)
{
for (uint32_t ii = 0; ii < BX_COUNTOF(m_program); ++ii)
{
m_program[ii] = BGFX_INVALID_HANDLE;
}
}
void init();
void shutdown();
static bool isSupported(TextureFormat::Enum _format)
{
return BX_ENABLED(BGFX_CONFIG_MIP_GEN_FALLBACK)
&& (false
|| TextureFormat::RGBA8 == _format
|| TextureFormat::BGRA8 == _format
|| TextureFormat::RGBA16 == _format
|| TextureFormat::RGBA16F == _format
|| TextureFormat::RGBA32F == _format
);
}
ProgramHandle m_program[4];
UniformHandle u_mipGen;
UniformHandle s_texMipSrc;
};
///
struct BlitFallback
{
BlitFallback()
{
for (uint32_t ii = 0; ii < BX_COUNTOF(m_program); ++ii)
{
m_program[ii] = BGFX_INVALID_HANDLE;
}
}
void init();
void shutdown();
enum Enum
{
TextureToBuffer,
BufferToTexture,
Count
};
ProgramHandle m_program[Count];
};
extern BlitFallback* g_blitFallback;
///
struct VideoDecode
{
VideoDecode()
: m_program(BGFX_INVALID_HANDLE)
, s_texY(BGFX_INVALID_HANDLE)
, s_texCbCr(BGFX_INVALID_HANDLE)
{
}
void init();
void shutdown();
ProgramHandle m_program;
UniformHandle s_texY;
UniformHandle s_texCbCr;
};
extern VideoDecode* g_videoDecode;
struct PredefinedUniform
{
enum Enum
{
ViewRect,
ViewTexel,
View,
InvView,
Proj,
InvProj,
ViewProj,
InvViewProj,
Model,
ModelView,
InvModelView,
ModelViewProj,
AlphaRef,
IndirectArgBase,
Count
};
uint32_t m_loc;
uint16_t m_count;
uint8_t m_type;
};
const char* getUniformTypeName(UniformType::Enum _enum);
UniformType::Enum nameToUniformTypeEnum(const char* _name);
const char* getPredefinedUniformName(PredefinedUniform::Enum _enum);
PredefinedUniform::Enum nameToPredefinedUniformEnum(const bx::StringView& _name);
class CommandBuffer
{
BX_CLASS(CommandBuffer
, NO_COPY
);
public:
CommandBuffer()
: m_buffer(NULL)
, m_pos(0)
, m_size(0)
, m_minCapacity(0)
, m_peak(0)
{
resize();
finish();
}
~CommandBuffer()
{
bx::free(g_allocator, m_buffer);
}
void init(uint32_t _minCapacity)
{
m_minCapacity = bx::alignUp(_minCapacity, 1024);
resize();
}
enum Enum
{
RendererInit,
RendererShutdownBegin,
CreateVertexLayout,
CreateIndexBuffer,
CreateVertexBuffer,
CreateDynamicIndexBuffer,
UpdateDynamicIndexBuffer,
CreateDynamicVertexBuffer,
UpdateDynamicVertexBuffer,
CreateShader,
CreateProgram,
CreateTexture,
UpdateTexture,
ClearTexture,
ResizeTexture,
CreateFrameBuffer,
ResizeFrameBuffer,
CreateUniform,
UpdateViewName,
InvalidateOcclusionQuery,
SetName,
End,
RendererShutdownEnd,
DestroyVertexLayout,
DestroyIndexBuffer,
DestroyVertexBuffer,
DestroyDynamicIndexBuffer,
DestroyDynamicVertexBuffer,
DestroyShader,
DestroyProgram,
DestroyTexture,
DestroyFrameBuffer,
DestroyUniform,
ReadTexture,
ReadBuffer,
};
void resize(uint32_t _capacity = 0)
{
m_capacity = bx::alignUp(bx::max(_capacity, m_minCapacity), 1024);
m_buffer = (uint8_t*)bx::realloc(g_allocator, m_buffer, m_capacity);
}
void write(const void* _data, uint32_t _size)
{
BX_ASSERT(m_size == 0, "Called write outside start/finish (m_size: %d)?", m_size);
if (m_pos + _size > m_capacity)
{
resize(m_capacity + (16<<10) );
}
bx::memCopy(&m_buffer[m_pos], _data, _size);
m_pos += _size;
}
template<typename Type>
void write(const Type& _in)
{
align(BX_ALIGNOF(Type) );
write(reinterpret_cast<const uint8_t*>(&_in), sizeof(Type) );
}
void write(const bx::StringView& _str)
{
const uint16_t len = bx::narrowCast<uint16_t>(_str.getLength()+1);
write(len);
write(_str.getPtr(), len-1);
write('\0');
}
void read(void* _data, uint32_t _size)
{
BX_ASSERT(m_pos + _size <= m_size
, "CommandBuffer::read error (pos: %d-%d, size: %d)."
, m_pos
, m_pos + _size
, m_size
);
bx::memCopy(_data, &m_buffer[m_pos], _size);
m_pos += _size;
}
template<typename Type>
void read(Type& _in)
{
align(BX_ALIGNOF(Type) );
read(reinterpret_cast<uint8_t*>(&_in), sizeof(Type) );
}
const uint8_t* skip(uint32_t _size)
{
BX_ASSERT(m_pos + _size <= m_size
, "CommandBuffer::skip error (pos: %d-%d, size: %d)."
, m_pos
, m_pos + _size
, m_size
);
const uint8_t* result = &m_buffer[m_pos];
m_pos += _size;
return result;
}
template<typename Type>
void skip()
{
align(BX_ALIGNOF(Type) );
skip(sizeof(Type) );
}
void align(uint32_t _alignment)
{
const uint32_t mask = _alignment-1;
const uint32_t pos = (m_pos+mask) & (~mask);
m_pos = pos;
}
void reset()
{
m_pos = 0;
}
void start()
{
m_pos = 0;
m_size = 0;
}
void finish()
{
uint8_t cmd = End;
write(cmd);
m_size = m_pos;
m_peak = bx::max(m_peak, m_pos);
m_pos = 0;
}
void shrink()
{
const uint32_t keep = bx::alignUp(bx::max(m_peak, m_minCapacity), 1024);
if (keep < m_capacity)
{
resize(keep);
}
m_peak = 0;
}
uint8_t* m_buffer;
uint32_t m_pos;
uint32_t m_size;
uint32_t m_capacity;
uint32_t m_minCapacity;
uint32_t m_peak;
};
//
static constexpr uint8_t kSortKeyViewNumBits = uint8_t(31 - bx::countLeadingZeros<uint32_t>(BGFX_CONFIG_MAX_VIEWS) );
static constexpr uint8_t kSortKeyViewBitShift = 64-kSortKeyViewNumBits;
static constexpr uint64_t kSortKeyViewMask = uint64_t(BGFX_CONFIG_MAX_VIEWS-1)<<kSortKeyViewBitShift;
static constexpr uint8_t kSortKeyDrawBitShift = kSortKeyViewBitShift - 1;
static constexpr uint64_t kSortKeyDrawBit = uint64_t(1)<<kSortKeyDrawBitShift;
//
static constexpr uint8_t kSortKeyDrawTypeNumBits = 2;
static constexpr uint8_t kSortKeyDrawTypeBitShift = kSortKeyDrawBitShift - kSortKeyDrawTypeNumBits;
static constexpr uint64_t kSortKeyDrawTypeMask = uint64_t(3)<<kSortKeyDrawTypeBitShift;
static constexpr uint64_t kSortKeyDrawTypeProgram = uint64_t(0)<<kSortKeyDrawTypeBitShift;
static constexpr uint64_t kSortKeyDrawTypeDepth = uint64_t(1)<<kSortKeyDrawTypeBitShift;
static constexpr uint64_t kSortKeyDrawTypeSequence = uint64_t(2)<<kSortKeyDrawTypeBitShift;
//
static constexpr uint8_t kSortKeyTransNumBits = 2;
static constexpr uint8_t kSortKeyDraw0BlendShift = kSortKeyDrawTypeBitShift - kSortKeyTransNumBits;
static constexpr uint64_t kSortKeyDraw0BlendMask = uint64_t(0x3)<<kSortKeyDraw0BlendShift;
static constexpr uint8_t kSortKeyAlphaRefNumBits = 1;
static constexpr uint8_t kSortKeyDraw0AlphaRefShift = kSortKeyDraw0BlendShift - kSortKeyAlphaRefNumBits;
static constexpr uint64_t kSortKeyDraw0AlphaRefMask = uint64_t(1)<<kSortKeyDraw0AlphaRefShift;
static constexpr uint8_t kSortKeyDraw0ProgramShift = kSortKeyDraw0AlphaRefShift - BGFX_CONFIG_SORT_KEY_NUM_BITS_PROGRAM;
static constexpr uint64_t kSortKeyDraw0ProgramMask = uint64_t(BGFX_CONFIG_MAX_PROGRAMS-1)<<kSortKeyDraw0ProgramShift;
static constexpr uint8_t kSortKeyDraw0DepthShift = kSortKeyDraw0ProgramShift - BGFX_CONFIG_SORT_KEY_NUM_BITS_DEPTH;
static constexpr uint64_t kSortKeyDraw0DepthMask = ( (uint64_t(1)<<BGFX_CONFIG_SORT_KEY_NUM_BITS_DEPTH)-1)<<kSortKeyDraw0DepthShift;
//
static constexpr uint8_t kSortKeyDraw1DepthShift = kSortKeyDrawTypeBitShift - BGFX_CONFIG_SORT_KEY_NUM_BITS_DEPTH;
static constexpr uint64_t kSortKeyDraw1DepthMask = ( (uint64_t(1)<<BGFX_CONFIG_SORT_KEY_NUM_BITS_DEPTH)-1)<<kSortKeyDraw1DepthShift;
static constexpr uint8_t kSortKeyDraw1BlendShift = kSortKeyDraw1DepthShift - kSortKeyTransNumBits;
static constexpr uint64_t kSortKeyDraw1BlendMask = uint64_t(0x3)<<kSortKeyDraw1BlendShift;
static constexpr uint8_t kSortKeyDraw1AlphaRefShift = kSortKeyDraw1BlendShift - kSortKeyAlphaRefNumBits;
static constexpr uint64_t kSortKeyDraw1AlphaRefMask = uint64_t(1)<<kSortKeyDraw1AlphaRefShift;
static constexpr uint8_t kSortKeyDraw1ProgramShift = kSortKeyDraw1AlphaRefShift - BGFX_CONFIG_SORT_KEY_NUM_BITS_PROGRAM;
static constexpr uint64_t kSortKeyDraw1ProgramMask = uint64_t(BGFX_CONFIG_MAX_PROGRAMS-1)<<kSortKeyDraw1ProgramShift;
//
static constexpr uint8_t kSortKeyDraw2SeqShift = kSortKeyDrawTypeBitShift - BGFX_CONFIG_SORT_KEY_NUM_BITS_SEQ;
static constexpr uint64_t kSortKeyDraw2SeqMask = ( (uint64_t(1)<<BGFX_CONFIG_SORT_KEY_NUM_BITS_SEQ)-1)<<kSortKeyDraw2SeqShift;
static constexpr uint8_t kSortKeyDraw2BlendShift = kSortKeyDraw2SeqShift - kSortKeyTransNumBits;
static constexpr uint64_t kSortKeyDraw2BlendMask = uint64_t(0x3)<<kSortKeyDraw2BlendShift;
static constexpr uint8_t kSortKeyDraw2AlphaRefShift = kSortKeyDraw2BlendShift - kSortKeyAlphaRefNumBits;
static constexpr uint64_t kSortKeyDraw2AlphaRefMask = uint64_t(1)<<kSortKeyDraw2AlphaRefShift;
static constexpr uint8_t kSortKeyDraw2ProgramShift = kSortKeyDraw2AlphaRefShift - BGFX_CONFIG_SORT_KEY_NUM_BITS_PROGRAM;
static constexpr uint64_t kSortKeyDraw2ProgramMask = uint64_t(BGFX_CONFIG_MAX_PROGRAMS-1)<<kSortKeyDraw2ProgramShift;
//
static constexpr uint8_t kSortKeyComputeSeqShift = kSortKeyDrawBitShift - BGFX_CONFIG_SORT_KEY_NUM_BITS_SEQ;
static constexpr uint64_t kSortKeyComputeSeqMask = ( (uint64_t(1)<<BGFX_CONFIG_SORT_KEY_NUM_BITS_SEQ)-1)<<kSortKeyComputeSeqShift;
static constexpr uint8_t kSortKeyComputeProgramShift = kSortKeyComputeSeqShift - BGFX_CONFIG_SORT_KEY_NUM_BITS_PROGRAM;
static constexpr uint64_t kSortKeyComputeProgramMask = uint64_t(BGFX_CONFIG_MAX_PROGRAMS-1)<<kSortKeyComputeProgramShift;
static_assert(BGFX_CONFIG_MAX_VIEWS <= (1<<kSortKeyViewNumBits) );
static_assert(BGFX_CONFIG_MAX_DRAW_CALLS <= (1<<BGFX_CONFIG_SORT_KEY_NUM_BITS_SEQ), "BGFX_CONFIG_MAX_DRAW_CALLS must fit into BGFX_CONFIG_SORT_KEY_NUM_BITS_SEQ bits.");
static_assert( (BGFX_CONFIG_MAX_PROGRAMS & (BGFX_CONFIG_MAX_PROGRAMS-1) ) == 0); // Must be power of 2.
static_assert( (0 // Render key mask shouldn't overlap.
| kSortKeyViewMask
| kSortKeyDrawBit
| kSortKeyDrawTypeMask
| kSortKeyDraw0BlendMask
| kSortKeyDraw0AlphaRefMask
| kSortKeyDraw0ProgramMask
| kSortKeyDraw0DepthMask
) == (0
^ kSortKeyViewMask
^ kSortKeyDrawBit
^ kSortKeyDrawTypeMask
^ kSortKeyDraw0BlendMask
^ kSortKeyDraw0AlphaRefMask
^ kSortKeyDraw0ProgramMask
^ kSortKeyDraw0DepthMask
) );
static_assert( (0 // Render key mask shouldn't overlap.
| kSortKeyViewMask
| kSortKeyDrawBit
| kSortKeyDrawTypeMask
| kSortKeyDraw1DepthMask
| kSortKeyDraw1BlendMask
| kSortKeyDraw1AlphaRefMask
| kSortKeyDraw1ProgramMask
) == (0
^ kSortKeyViewMask
^ kSortKeyDrawBit
^ kSortKeyDrawTypeMask
^ kSortKeyDraw1DepthMask
^ kSortKeyDraw1BlendMask
^ kSortKeyDraw1AlphaRefMask
^ kSortKeyDraw1ProgramMask
) );
static_assert( (0 // Render key mask shouldn't overlap.
| kSortKeyViewMask
| kSortKeyDrawBit
| kSortKeyDrawTypeMask
| kSortKeyDraw2SeqMask
| kSortKeyDraw2BlendMask
| kSortKeyDraw2AlphaRefMask
| kSortKeyDraw2ProgramMask
) == (0
^ kSortKeyViewMask
^ kSortKeyDrawBit
^ kSortKeyDrawTypeMask
^ kSortKeyDraw2SeqMask
^ kSortKeyDraw2BlendMask
^ kSortKeyDraw2AlphaRefMask
^ kSortKeyDraw2ProgramMask
) );
static_assert( (0 // Compute key mask shouldn't overlap.
| kSortKeyViewMask
| kSortKeyDrawBit
| kSortKeyComputeSeqShift
| kSortKeyComputeProgramMask
) == (0
^ kSortKeyViewMask
^ kSortKeyDrawBit
^ kSortKeyComputeSeqShift
^ kSortKeyComputeProgramMask
) );
// | 3 2 1 0|
// |fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210| Common
// |vvvvvvvvd |
// | ^^ |
// | || |
// | view-+| |
// | +-draw |
// |----------------------------------------------------------------| Draw Key 0 - Sort by program
// | |kkttrpppppppppdddddddddddddddddddddddddddddddd |
// | | ^ ^^ ^ ^ |
// | | | |+ref | | |
// | | | +-blend +-program depth-+ |
// | | +-key type |
// |----------------------------------------------------------------| Draw Key 1 - Sort by depth
// | |kkddddddddddddddddddddddddddddddddttrppppppppp |
// | | ^ ^ ^+-ref ^ |
// | | | | +-blend | |
// | | +-key type depth-+ program-+ |
// | | |
// |----------------------------------------------------------------| Draw Key 2 - Sequential
// | |kkssssssssssssssssssssttrppppppppp |
// | | ^ ^ ^^ ^ |
// | | | | |+-ref | |
// | | +-key type seq-+ +-blend +-program |
// | | |
// |----------------------------------------------------------------| Compute Key
// | |ssssssssssssssssssssppppppppp |
// | | ^ ^ |
// | | | | |
// | | seq-+ +-program |
// | | |
// |--------+-------------------------------------------------------|
//
struct SortKey
{
enum Enum
{
SortProgram,
SortDepth,
SortSequence,
};
uint64_t encodeDraw(Enum _type)
{
switch (_type)
{
case SortProgram:
{
const uint64_t depth = (uint64_t(m_depth ) << kSortKeyDraw0DepthShift ) & kSortKeyDraw0DepthMask;
const uint64_t program = (uint64_t(m_program.idx) << kSortKeyDraw0ProgramShift ) & kSortKeyDraw0ProgramMask;
const uint64_t blend = (uint64_t(m_blend ) << kSortKeyDraw0BlendShift ) & kSortKeyDraw0BlendMask;
const uint64_t alphaRef = (uint64_t(m_hasAlphaRef) << kSortKeyDraw0AlphaRefShift) & kSortKeyDraw0AlphaRefMask;
const uint64_t view = (uint64_t(m_view ) << kSortKeyViewBitShift ) & kSortKeyViewMask;
const uint64_t key = view|kSortKeyDrawBit|kSortKeyDrawTypeProgram|blend|alphaRef|program|depth;
return key;
}
break;
case SortDepth:
{
const uint64_t depth = (uint64_t(m_depth ) << kSortKeyDraw1DepthShift ) & kSortKeyDraw1DepthMask;
const uint64_t program = (uint64_t(m_program.idx) << kSortKeyDraw1ProgramShift) & kSortKeyDraw1ProgramMask;
const uint64_t blend = (uint64_t(m_blend ) << kSortKeyDraw1BlendShift) & kSortKeyDraw1BlendMask;
const uint64_t alphaRef = (uint64_t(m_hasAlphaRef) << kSortKeyDraw1AlphaRefShift) & kSortKeyDraw1AlphaRefMask;
const uint64_t view = (uint64_t(m_view ) << kSortKeyViewBitShift ) & kSortKeyViewMask;
const uint64_t key = view|kSortKeyDrawBit|kSortKeyDrawTypeDepth|depth|blend|alphaRef|program;
return key;
}
break;
case SortSequence:
{
const uint64_t seq = (uint64_t(m_seq ) << kSortKeyDraw2SeqShift ) & kSortKeyDraw2SeqMask;
const uint64_t program = (uint64_t(m_program.idx) << kSortKeyDraw2ProgramShift ) & kSortKeyDraw2ProgramMask;
const uint64_t blend = (uint64_t(m_blend ) << kSortKeyDraw2BlendShift ) & kSortKeyDraw2BlendMask;
const uint64_t alphaRef = (uint64_t(m_hasAlphaRef) << kSortKeyDraw2AlphaRefShift) & kSortKeyDraw2AlphaRefMask;
const uint64_t view = (uint64_t(m_view ) << kSortKeyViewBitShift ) & kSortKeyViewMask;
const uint64_t key = view|kSortKeyDrawBit|kSortKeyDrawTypeSequence|seq|blend|alphaRef|program;
BX_ASSERT(seq == (uint64_t(m_seq) << kSortKeyDraw2SeqShift)
, "SortKey error, sequence is truncated (m_seq: %d)."
, m_seq
);
return key;
}
break;
}
BX_ASSERT(false, "You should not be here.");
return 0;
}
uint64_t encodeCompute()
{
const uint64_t program = (uint64_t(m_program.idx) << kSortKeyComputeProgramShift) & kSortKeyComputeProgramMask;
const uint64_t seq = (uint64_t(m_seq ) << kSortKeyComputeSeqShift ) & kSortKeyComputeSeqMask;
const uint64_t view = (uint64_t(m_view ) << kSortKeyViewBitShift ) & kSortKeyViewMask;
const uint64_t key = program|seq|view;
BX_ASSERT(seq == (uint64_t(m_seq) << kSortKeyComputeSeqShift)
, "SortKey error, sequence is truncated (m_seq: %d)."
, m_seq
);
return key;
}
/// Returns true if item is compute command.
bool decode(uint64_t _key, ViewId _viewRemap[BGFX_CONFIG_MAX_VIEWS])
{
m_view = _viewRemap[(_key & kSortKeyViewMask) >> kSortKeyViewBitShift];
if (_key & kSortKeyDrawBit)
{
uint64_t type = _key & kSortKeyDrawTypeMask;
if (type == kSortKeyDrawTypeDepth)
{
m_program.idx = uint16_t( (_key & kSortKeyDraw1ProgramMask) >> kSortKeyDraw1ProgramShift);
return false;
}
if (type == kSortKeyDrawTypeSequence)
{
m_program.idx = uint16_t( (_key & kSortKeyDraw2ProgramMask) >> kSortKeyDraw2ProgramShift);
return false;
}
m_program.idx = uint16_t( (_key & kSortKeyDraw0ProgramMask) >> kSortKeyDraw0ProgramShift);
return false; // draw
}
m_program.idx = uint16_t( (_key & kSortKeyComputeProgramMask) >> kSortKeyComputeProgramShift);
return true; // compute
}
static ViewId decodeView(uint64_t _key)
{
return ViewId( (_key & kSortKeyViewMask) >> kSortKeyViewBitShift);
}
static uint64_t remapView(uint64_t _key, ViewId _viewRemap[BGFX_CONFIG_MAX_VIEWS])
{
const ViewId oldView = decodeView(_key);
const uint64_t view = uint64_t(_viewRemap[oldView]) << kSortKeyViewBitShift;
const uint64_t key = (_key & ~kSortKeyViewMask) | view;
return key;
}
void reset()
{
m_depth = 0;
m_seq = 0;
m_program = {0};
m_view = 0;
m_blend = 0;
m_hasAlphaRef = false;
}
uint32_t m_depth;
uint32_t m_seq;
ProgramHandle m_program;
ViewId m_view;
uint8_t m_blend;
bool m_hasAlphaRef;
};
#undef SORT_KEY_RENDER_DRAW
struct BlitKey
{
using KeyT = uint32_t;
static constexpr uint8_t kViewShift = 32-kSortKeyViewNumBits;
static constexpr uint32_t kViewMask = uint32_t(BGFX_CONFIG_MAX_VIEWS-1)<<kViewShift;
static constexpr uint8_t kItemShift = 0;
static constexpr uint32_t kItemMask = UINT16_MAX;
static_assert( (0
| kViewMask
| kItemMask
) == (0
^ kViewMask
^ kItemMask
), "BlitKey: Key mask shouldn't overlap!");
static_assert(BGFX_CONFIG_MAX_BLIT_ITEMS <= kItemMask+1
, "BGFX_CONFIG_MAX_BLIT_ITEMS doesn't fit in the BlitKey item field."
);
KeyT encode()
{
const KeyT view = (KeyT(m_view) << kViewShift) & kViewMask;
const KeyT item = (KeyT(m_item) << kItemShift) & kItemMask;
const KeyT key = view|item;
return key;
}
void decode(KeyT _key)
{
m_item = uint16_t( (_key & kItemMask) >> kItemShift);
m_view = ViewId( (_key & kViewMask) >> kViewShift);
}
static KeyT remapView(KeyT _key, ViewId _viewRemap[BGFX_CONFIG_MAX_VIEWS])
{
const ViewId oldView = ViewId( (_key & kViewMask) >> kViewShift);
const KeyT view = uint32_t( (_viewRemap[oldView] << kViewShift) & kViewMask);
const KeyT key = (_key & ~kViewMask) | view;
return key;
}
uint16_t m_item;
ViewId m_view;
};
BX_ALIGN_DECL_16(struct) Srt
{
float rotate[4];
float translate[3];
float pad0;
float scale[3];
float pad1;
};
BX_ALIGN_DECL_16(struct) Matrix4
{
union
{
float val[16];
bx::float4x4_t f4x4;
} un;
void setIdentity()
{
bx::memSet(un.val, 0, sizeof(un.val) );
un.val[0] = un.val[5] = un.val[10] = un.val[15] = 1.0f;
}
};
template<typename Ty, uint32_t BlockT>
class FrameArenaT
{
public:
static_assert(bx::isPowerOf2(BlockT), "FrameArenaT BlockT must be power of two.");
~FrameArenaT()
{
destroy();
}
#if BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
static constexpr uint32_t kBlockMask = BlockT - 1;
FrameArenaT()
: m_block(NULL)
, m_reserved(NULL)
, m_numBlocks(0)
, m_numReservedBlocks(0)
, m_reservedCount(0)
{
}
void create(uint32_t _numReserved, uint32_t _numMax)
{
destroy();
m_numBlocks = numBlocks(_numMax);
m_numReservedBlocks = bx::min(numBlocks(_numReserved), m_numBlocks);
m_reservedCount = m_numReservedBlocks * BlockT;
m_block = (Ty**)bx::alloc(g_allocator, sizeof(Ty*)*m_numBlocks);
bx::memSet(m_block, 0, sizeof(Ty*)*m_numBlocks);
if (0 < m_numReservedBlocks)
{
const uint32_t size = sizeof(Ty)*BlockT*m_numReservedBlocks;
m_reserved = (Ty*)bx::alloc(g_allocator, size, BX_ALIGNOF(Ty) );
bx::memSet(m_reserved, 0, size);
for (uint32_t ii = 0; ii < m_numReservedBlocks; ++ii)
{
m_block[ii] = m_reserved + ii*BlockT;
}
}
}
void destroy()
{
shrink(0);
if (NULL != m_reserved)
{
bx::free(g_allocator, m_reserved, BX_ALIGNOF(Ty) );
m_reserved = NULL;
}
bx::free(g_allocator, m_block);
m_block = NULL;
m_numBlocks = 0;
m_numReservedBlocks = 0;
m_reservedCount = 0;
}
BX_FORCE_INLINE Ty& operator[](uint32_t _idx)
{
if (_idx < m_reservedCount)
{
return m_reserved[_idx];
}
const uint32_t blockIdx = _idx / BlockT;
Ty* block = load(blockIdx);
if (NULL == block)
{
block = allocBlock(blockIdx);
}
return block[_idx & kBlockMask];
}
BX_FORCE_INLINE const Ty& operator[](uint32_t _idx) const
{
if (_idx < m_reservedCount)
{
return m_reserved[_idx];
}
return load(_idx / BlockT)[_idx & kBlockMask];
}
void shrink(uint32_t _numItems)
{
for (uint32_t ii = bx::max(m_numReservedBlocks, numBlocks(_numItems) ); ii < m_numBlocks; ++ii)
{
if (NULL != m_block[ii])
{
bx::free(g_allocator, m_block[ii], BX_ALIGNOF(Ty) );
m_block[ii] = NULL;
}
}
}
private:
static BX_FORCE_INLINE uint32_t numBlocks(uint32_t _numItems)
{
return (_numItems + BlockT - 1)/BlockT;
}
BX_FORCE_INLINE Ty* load(uint32_t _blockIdx) const
{
return *(Ty* volatile*)&m_block[_blockIdx];
}
BX_NO_INLINE Ty* allocBlock(uint32_t _blockIdx)
{
bx::MutexScope lock(m_lock);
Ty* block = m_block[_blockIdx];
if (NULL == block)
{
constexpr uint32_t size = sizeof(Ty)*BlockT;
block = (Ty*)bx::alloc(g_allocator, size, BX_ALIGNOF(Ty) );
bx::memSet(block, 0, size);
bx::atomicExchangePtr( (void**)&m_block[_blockIdx], block);
}
return block;
}
Ty** m_block;
Ty* m_reserved;
uint32_t m_numBlocks;
uint32_t m_numReservedBlocks;
uint32_t m_reservedCount;
bx::Mutex m_lock;
#else
FrameArenaT()
: m_data(NULL)
{
}
void create(uint32_t /*_numReserved*/, uint32_t _numMax)
{
destroy();
const uint32_t size = sizeof(Ty)*_numMax;
m_data = (Ty*)bx::alloc(g_allocator, size, BX_ALIGNOF(Ty) );
bx::memSet(m_data, 0, size);
}
void destroy()
{
if (NULL != m_data)
{
bx::free(g_allocator, m_data, BX_ALIGNOF(Ty) );
m_data = NULL;
}
}
BX_FORCE_INLINE Ty& operator[](uint32_t _idx)
{
return m_data[_idx];
}
BX_FORCE_INLINE const Ty& operator[](uint32_t _idx) const
{
return m_data[_idx];
}
void shrink(uint32_t /*_numItems*/)
{
}
private:
Ty* m_data;
#endif // BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
};
struct MatrixCache
{
static constexpr uint32_t kMaxChunks = 16;
MatrixCache()
: m_num(1)
, m_max(0)
, m_capacity(0)
, m_numChunks(0)
, m_peak(0)
, m_observe(0)
, m_numPeakFrames(0)
{
bx::memSet(m_chunk, 0, sizeof(m_chunk) );
bx::memSet(m_chunkBase, 0, sizeof(m_chunkBase) );
bx::memSet(m_chunkSize, 0, sizeof(m_chunkSize) );
m_identity.setIdentity();
}
void create(uint32_t _numReserved, uint32_t _numMax, uint32_t _numPeakFrames)
{
m_capacity = bx::min<uint32_t>(_numMax, BGFX_CONFIG_MAX_MATRIX_CACHE);
if (!BX_ENABLED(BGFX_CONFIG_DYNAMIC_FRAME_STORAGE) )
{
_numReserved = m_capacity;
_numPeakFrames = 0;
}
resize(bx::min(_numReserved, m_capacity) );
m_num = 1;
m_peak = 0;
m_observe = 0;
m_numPeakFrames = _numPeakFrames;
}
void destroy()
{
freeChunks();
}
void freeChunks()
{
for (uint32_t ii = 0; ii < m_numChunks; ++ii)
{
bx::free(g_allocator, m_chunk[ii], BX_ALIGNOF(Matrix4) );
m_chunk[ii] = NULL;
}
m_numChunks = 0;
m_max = 0;
}
void resize(uint32_t _max)
{
freeChunks();
addChunk(_max);
}
bool addChunk(uint32_t _num)
{
if (m_numChunks == kMaxChunks
|| m_max >= m_capacity)
{
return false;
}
const uint32_t size = bx::min(
m_capacity - m_max
, bx::max(_num, bx::max<uint32_t>(kDrawCallBlock, m_max) )
);
Matrix4* chunk = (Matrix4*)bx::alloc(g_allocator, sizeof(Matrix4)*size, BX_ALIGNOF(Matrix4) );
if (0 == m_numChunks)
{
chunk[0].setIdentity();
}
m_chunkBase[m_numChunks] = m_max;
m_chunkSize[m_numChunks] = size;
m_chunk[m_numChunks] = chunk;
bx::atomicFetchAndAdd<uint32_t>(&m_numChunks, 1);
bx::atomicFetchAndAdd<uint32_t>(&m_max, size);
return true;
}
Matrix4& at(uint32_t _idx)
{
if (_idx < m_chunkSize[0])
{
return m_chunk[0][_idx];
}
for (uint32_t ii = 1, num = m_numChunks; ii < num; ++ii)
{
const uint32_t base = m_chunkBase[ii];
if (_idx >= base
&& _idx < base + m_chunkSize[ii])
{
return m_chunk[ii][_idx - base];
}
}
return m_identity;
}
const Matrix4& at(uint32_t _idx) const
{
return const_cast<MatrixCache*>(this)->at(_idx);
}
uint32_t capacityFor(uint32_t _used) const
{
return bx::min<uint32_t>(m_capacity, uint32_t(bx::alignUp(_used-1, kDrawCallBlock) )+1);
}
void reset()
{
const uint32_t used = m_num;
if (1 < m_numChunks)
{
resize(bx::min(m_capacity, capacityFor(used) ) );
m_peak = 0;
m_observe = 0;
}
else if (0 != m_numPeakFrames)
{
m_peak = bx::max(m_peak, used);
if (++m_observe >= m_numPeakFrames)
{
const uint32_t want = bx::max<uint32_t>(kDrawCallBlock+1, capacityFor(m_peak) );
if (want < m_max)
{
resize(want);
}
m_peak = 0;
m_observe = 0;
}
}
m_num = 1;
}
uint32_t reserve(uint16_t* _num)
{
const uint32_t num = *_num;
for (;;)
{
const uint32_t max = m_max;
const uint32_t first = bx::atomicFetchAndAddsat<uint32_t>(&m_num, num, max);
if (first + num <= max)
{
*_num = bx::narrowCast<uint16_t>(num);
return first;
}
if (!grow(num, max) )
{
*_num = 0;
return m_max;
}
}
}
BX_NO_INLINE bool grow(uint32_t _num, uint32_t _max)
{
bx::MutexScope lock(m_lock);
if (m_max != _max)
{
return true;
}
return addChunk(_num);
}
uint32_t add(const void* _mtx, uint16_t* _num)
{
if (NULL != _mtx)
{
uint32_t first = reserve(_num);
if (0 != *_num)
{
bx::memCopy(&at(first), _mtx, sizeof(Matrix4)*(*_num) );
}
return first;
}
*_num = 1;
return 0;
}
float* toPtr(uint32_t _cacheIdx)
{
return at(_cacheIdx).un.val;
}
Matrix4* m_chunk[kMaxChunks];
uint32_t m_chunkBase[kMaxChunks];
uint32_t m_chunkSize[kMaxChunks];
Matrix4 m_identity;
uint32_t m_num;
uint32_t m_max;
uint32_t m_capacity;
uint32_t m_numChunks;
uint32_t m_peak;
uint32_t m_observe;
uint32_t m_numPeakFrames;
bx::Mutex m_lock;
};
struct RectCache
{
static_assert(BGFX_CONFIG_MAX_RECT_CACHE <= UINT16_MAX
, "BGFX_CONFIG_MAX_RECT_CACHE must leave UINT16_MAX free."
);
RectCache()
: m_num(0)
, m_max(0)
{
}
void create(uint32_t _numMax)
{
m_max = _numMax;
m_cache.create(0, _numMax);
}
void destroy()
{
m_cache.destroy();
}
void reset()
{
m_num = 0;
}
void shrink(uint32_t _numItems)
{
m_cache.shrink(bx::min(m_max, _numItems) );
}
uint32_t add(uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height)
{
const uint32_t first = bx::atomicFetchAndAddsat<uint32_t>(&m_num, 1, m_max);
BX_WARN(first < m_max
, "Exceeded number of available scissor rectangles per frame. BGFX_CONFIG_MAX_RECT_CACHE is %d."
, BGFX_CONFIG_MAX_RECT_CACHE
);
if (first >= m_max)
{
return UINT16_MAX;
}
Rect& rect = m_cache[first];
rect.m_x = bx::narrowCast<int16_t>(_x);
rect.m_y = bx::narrowCast<int16_t>(_y);
rect.m_width = _width;
rect.m_height = _height;
return first;
}
FrameArenaT<Rect, kRectBlock> m_cache;
uint32_t m_num;
uint32_t m_max;
};
static constexpr uint8_t kConstantOpcodeTypeShift = 27;
static constexpr uint32_t kConstantOpcodeTypeMask = UINT32_C(0xf8000000);
static constexpr uint8_t kConstantOpcodeLocShift = 11;
static constexpr uint32_t kConstantOpcodeLocMask = UINT32_C(0x07fff800);
static constexpr uint8_t kConstantOpcodeNumShift = 1;
static constexpr uint32_t kConstantOpcodeNumMask = UINT32_C(0x000007fe);
static constexpr uint8_t kConstantOpcodeCopyShift = 0;
static constexpr uint32_t kConstantOpcodeCopyMask = UINT32_C(0x00000001);
static constexpr uint8_t kUniformRefBit = 0x08;
static constexpr uint8_t kUniformFragmentBit = 0x10;
static constexpr uint8_t kUniformSamplerBit = 0x20;
static constexpr uint8_t kUniformReadOnlyBit = 0x40;
static constexpr uint8_t kUniformCompareBit = 0x80;
static constexpr uint8_t kUniformMask = 0
| kUniformFragmentBit
| kUniformSamplerBit
| kUniformReadOnlyBit
| kUniformCompareBit
;
class UniformBuffer
{
public:
static_assert(BGFX_CONFIG_UNIFORM_BUFFER_RESIZE_THRESHOLD_SIZE
>= sizeof(uint32_t) + (kConstantOpcodeNumMask>>kConstantOpcodeNumShift)*sizeof(float)*16
, "BGFX_CONFIG_UNIFORM_BUFFER_RESIZE_THRESHOLD_SIZE is too small!"
);
static_assert(BGFX_CONFIG_MIN_UNIFORM_BUFFER_SIZE > BGFX_CONFIG_UNIFORM_BUFFER_RESIZE_THRESHOLD_SIZE
, "BGFX_CONFIG_MIN_UNIFORM_BUFFER_SIZE must be larger than BGFX_CONFIG_UNIFORM_BUFFER_RESIZE_THRESHOLD_SIZE!"
);
static UniformBuffer* create(uint32_t _size)
{
const uint32_t structSize = sizeof(UniformBuffer)-sizeof(UniformBuffer::m_buffer);
uint32_t size = bx::alignUp(_size, 16);
void* data = bx::alloc(g_allocator, size+structSize);
return BX_PLACEMENT_NEW(data, UniformBuffer)(size);
}
static void destroy(UniformBuffer* _uniformBuffer)
{
_uniformBuffer->~UniformBuffer();
bx::free(g_allocator, _uniformBuffer);
}
static void update(UniformBuffer** _uniformBuffer)
{
static constexpr uint32_t kThreshold = BGFX_CONFIG_UNIFORM_BUFFER_RESIZE_THRESHOLD_SIZE;
static constexpr uint32_t kIncrement = BGFX_CONFIG_UNIFORM_BUFFER_RESIZE_INCREMENT_SIZE;
UniformBuffer* uniformBuffer = *_uniformBuffer;
if (kThreshold >= uniformBuffer->m_size - uniformBuffer->m_pos)
{
const uint32_t size = uniformBuffer->m_size
+ bx::max(kIncrement, uniformBuffer->m_size/2)
;
resize(_uniformBuffer, size);
}
}
static void shrink(UniformBuffer** _uniformBuffer, uint32_t _minSize)
{
static constexpr uint32_t kThreshold = BGFX_CONFIG_UNIFORM_BUFFER_RESIZE_THRESHOLD_SIZE;
static constexpr uint32_t kIncrement = BGFX_CONFIG_UNIFORM_BUFFER_RESIZE_INCREMENT_SIZE;
UniformBuffer* uniformBuffer = *_uniformBuffer;
const uint32_t keep = bx::alignUp(bx::max(_minSize, uniformBuffer->m_hwm + kThreshold), 16);
if (keep + kIncrement <= uniformBuffer->m_size)
{
resize(_uniformBuffer, keep);
}
(*_uniformBuffer)->m_hwm = 0;
}
static uint32_t encodeOpcode(uint8_t _type, uint16_t _loc, uint16_t _num, uint16_t _copy)
{
const uint32_t type = _type << kConstantOpcodeTypeShift;
const uint32_t loc = _loc << kConstantOpcodeLocShift;
const uint32_t num = _num << kConstantOpcodeNumShift;
const uint32_t copy = _copy << kConstantOpcodeCopyShift;
return type|loc|num|copy;
}
static void decodeOpcode(uint32_t _opcode, uint8_t& _type, uint16_t& _loc, uint16_t& _num, uint16_t& _copy)
{
const uint32_t type = (_opcode&kConstantOpcodeTypeMask) >> kConstantOpcodeTypeShift;
const uint32_t loc = (_opcode&kConstantOpcodeLocMask ) >> kConstantOpcodeLocShift;
const uint32_t num = (_opcode&kConstantOpcodeNumMask ) >> kConstantOpcodeNumShift;
const uint32_t copy = (_opcode&kConstantOpcodeCopyMask); // >> kConstantOpcodeCopyShift;
_type = (uint8_t )type;
_copy = (uint16_t)copy;
_num = (uint16_t)num;
_loc = (uint16_t)loc;
}
void write(const void* _data, uint32_t _size)
{
BX_ASSERT(m_pos + _size < m_size, "Write would go out of bounds. pos %d + size %d > max size: %d).", m_pos, _size, m_size);
if (m_pos + _size < m_size)
{
bx::memCopy(&m_buffer[m_pos], _data, _size);
m_pos += _size;
}
}
void write(uint32_t _value)
{
write(&_value, sizeof(uint32_t) );
}
const char* read(uint32_t _size)
{
BX_ASSERT(m_pos < m_size, "Out of bounds %d (size: %d).", m_pos, m_size);
const char* result = &m_buffer[m_pos];
m_pos += _size;
return result;
}
uint32_t read()
{
return bx::loadUnaligned<uint32_t>(read(sizeof(uint32_t) ) );
}
bool isEmpty() const
{
return 0 == m_pos;
}
uint32_t getPos() const
{
return m_pos;
}
void reset(uint32_t _pos = 0)
{
m_pos = _pos;
}
void finish()
{
write(UniformType::End);
m_hwm = bx::max(m_hwm, m_pos);
m_pos = 0;
}
void writeUniform(UniformType::Enum _type, uint16_t _loc, const void* _value, uint16_t _num = 1);
void writeUniformRef(UniformType::Enum _type, uint16_t _loc, const void* _ptr, uint16_t _num = 1);
void writeUniformHandle(uint8_t _type, uint16_t _loc, UniformHandle _handle, uint16_t _num = 1);
void writeMarker(const bx::StringView& _name);
private:
static void resize(UniformBuffer** _uniformBuffer, uint32_t _size)
{
const uint32_t structSize = sizeof(UniformBuffer)-sizeof(UniformBuffer::m_buffer);
const uint32_t size = bx::alignUp(_size, 16);
void* data = bx::realloc(g_allocator, *_uniformBuffer, size+structSize);
UniformBuffer* uniformBuffer = reinterpret_cast<UniformBuffer*>(data);
uniformBuffer->m_size = size;
*_uniformBuffer = uniformBuffer;
}
UniformBuffer(uint32_t _size)
: m_size(_size)
, m_pos(0)
, m_hwm(0)
{
finish();
}
~UniformBuffer()
{
}
uint32_t m_size;
uint32_t m_pos;
uint32_t m_hwm;
char m_buffer[256<<20];
};
struct UniformRegInfo
{
UniformHandle m_handle;
};
class UniformRegistry
{
public:
UniformRegistry()
{
}
~UniformRegistry()
{
}
const UniformRegInfo* find(const char* _name) const
{
uint16_t handle = m_uniforms.find(bx::hash<bx::HashMurmur2A>(_name) );
if (kInvalidHandle != handle)
{
return &m_info[handle];
}
return NULL;
}
const UniformRegInfo& add(UniformHandle _handle, const char* _name)
{
BX_ASSERT(isValid(_handle), "Uniform handle is invalid (name: %s)!", _name);
const uint32_t key = bx::hash<bx::HashMurmur2A>(_name);
m_uniforms.removeByKey(key);
m_uniforms.insert(key, _handle.idx);
UniformRegInfo& info = m_info[_handle.idx];
info.m_handle = _handle;
return info;
}
void remove(UniformHandle _handle)
{
m_uniforms.removeByHandle(_handle.idx);
}
private:
typedef bx::HandleHashMapT<BGFX_CONFIG_MAX_UNIFORMS*2> UniformHashMap;
UniformHashMap m_uniforms;
UniformRegInfo m_info[BGFX_CONFIG_MAX_UNIFORMS];
};
static constexpr uint32_t kBufferBindingOffsetAlign = 256;
struct Binding
{
enum Enum
{
Image,
IndexBuffer,
VertexBuffer,
Texture,
Count
};
struct LodClamp
{
uint8_t min;
uint8_t max;
uint8_t pad[2];
};
void reset()
{
m_samplerFlags = BGFX_SAMPLER_NONE;
m_offset = 0;
m_size = UINT32_MAX;
m_firstLayer = 0;
m_numLayers = UINT16_MAX;
m_idx = kInvalidHandle;
m_type = 0;
m_format = 0;
m_access = 0;
m_firstMip = 0;
m_numMips = UINT8_MAX;
m_pad = 0;
}
void setTexture(TextureHandle _handle, uint32_t _samplerFlags, uint8_t _firstMip = 0, uint8_t _numMips = UINT8_MAX)
{
m_samplerFlags = _samplerFlags;
m_lod.min = 0;
m_lod.max = UINT8_MAX;
m_lod.pad[0] = 0;
m_lod.pad[1] = 0;
m_size = UINT32_MAX;
m_firstLayer = 0;
m_numLayers = UINT16_MAX;
m_idx = _handle.idx;
m_type = uint8_t(Binding::Texture);
m_format = 0;
m_access = 0;
m_firstMip = _firstMip;
m_numMips = _numMips;
m_pad = 0;
}
void setTexture(TextureHandle _handle, uint16_t _firstLayer, uint16_t _numLayers, uint8_t _firstMip, uint8_t _numMips, uint32_t _samplerFlags, uint8_t _lodMin = 0, uint8_t _lodMax = UINT8_MAX)
{
m_samplerFlags = _samplerFlags;
m_lod.min = _lodMin;
m_lod.max = _lodMax;
m_lod.pad[0] = 0;
m_lod.pad[1] = 0;
m_size = UINT32_MAX;
m_firstLayer = _firstLayer;
m_numLayers = _numLayers;
m_idx = _handle.idx;
m_type = uint8_t(Binding::Texture);
m_format = 0;
m_access = 0;
m_firstMip = _firstMip;
m_numMips = _numMips;
m_pad = 0;
}
void setIndexBuffer(IndexBufferHandle _handle, Access::Enum _access, uint32_t _offset = 0, uint32_t _size = UINT32_MAX)
{
m_samplerFlags = BGFX_SAMPLER_NONE;
m_offset = _offset;
m_size = _size;
m_firstLayer = 0;
m_numLayers = UINT16_MAX;
m_idx = _handle.idx;
m_type = uint8_t(Binding::IndexBuffer);
m_format = 0;
m_access = uint8_t(_access);
m_firstMip = 0;
m_numMips = UINT8_MAX;
m_pad = 0;
}
void setBuffer(VertexBufferHandle _handle, Access::Enum _access, uint32_t _offset = 0, uint32_t _size = UINT32_MAX)
{
m_samplerFlags = BGFX_SAMPLER_NONE;
m_offset = _offset;
m_size = _size;
m_firstLayer = 0;
m_numLayers = UINT16_MAX;
m_idx = _handle.idx;
m_type = uint8_t(Binding::VertexBuffer);
m_format = 0;
m_access = uint8_t(_access);
m_firstMip = 0;
m_numMips = UINT8_MAX;
m_pad = 0;
}
void setImage(TextureHandle _handle, uint8_t _mip, Access::Enum _access, TextureFormat::Enum _format)
{
setImage(_handle, 0, UINT16_MAX, _mip, _access, _format);
}
void setImage(TextureHandle _handle, uint16_t _firstLayer, uint16_t _numLayers, uint8_t _mip, Access::Enum _access, TextureFormat::Enum _format)
{
m_samplerFlags = BGFX_SAMPLER_NONE;
m_offset = 0;
m_size = UINT32_MAX;
m_firstLayer = _firstLayer;
m_numLayers = _numLayers;
m_idx = _handle.idx;
m_type = uint8_t(Binding::Image);
m_format = uint8_t(_format);
m_access = uint8_t(_access);
m_firstMip = _mip;
m_numMips = 1;
m_pad = 0;
}
bool isOccupied() const
{
return kInvalidHandle != m_idx;
}
bool operator==(const Binding& _rhs) const
{
return 0 == bx::memCmp(this, &_rhs, sizeof(Binding) );
}
uint32_t m_samplerFlags;
union
{
uint32_t m_offset;
LodClamp m_lod;
};
uint32_t m_size;
uint16_t m_firstLayer;
uint16_t m_numLayers;
uint16_t m_idx;
uint8_t m_type;
uint8_t m_format;
uint8_t m_access;
uint8_t m_firstMip;
uint8_t m_numMips;
uint8_t m_pad;
};
static_assert(24 == sizeof(Binding), "Binding size changed. Whole struct must be properly initialized for hashing and comparing!");
static_assert(bx::hasUniqueObjectRepresentation<Binding>()
, "Binding is hashed and compared as bytes, so it must not have padding. Add an explicit member to fill the hole."
);
inline uint32_t bindingsMask(const Binding _bind[BGFX_CONFIG_MAX_TEXTURE_SAMPLERS])
{
uint32_t mask = 0;
for (uint32_t ii = 0; ii < BGFX_CONFIG_MAX_TEXTURE_SAMPLERS; ++ii)
{
mask |= uint32_t(_bind[ii].isOccupied() ) << ii;
}
return mask;
}
inline uint32_t hashBindings(const Binding _bind[BGFX_CONFIG_MAX_TEXTURE_SAMPLERS], uint32_t _mask)
{
BX_ASSERT(_mask == bindingsMask(_bind), "Bind occupancy mask 0x%08x is stale (expected 0x%08x)."
, _mask
, bindingsMask(_bind)
);
bx::HashMurmur3 murmur;
murmur.begin();
murmur.add(_mask);
for (BitMaskToIndexIteratorT<uint32_t> it(_mask); !it.isDone(); it.next() )
{
murmur.add(_bind[it.idx]);
}
return murmur.end();
}
inline uint32_t hashBindings(const Binding _bind[BGFX_CONFIG_MAX_TEXTURE_SAMPLERS])
{
return hashBindings(_bind, bindingsMask(_bind) );
}
inline bool bindingsEqual(
const Binding _lhs[BGFX_CONFIG_MAX_TEXTURE_SAMPLERS]
, const Binding _rhs[BGFX_CONFIG_MAX_TEXTURE_SAMPLERS]
)
{
const uint32_t mask = bindingsMask(_lhs);
if (mask != bindingsMask(_rhs) )
{
return false;
}
for (BitMaskToIndexIteratorT<uint32_t> it(mask); !it.isDone(); it.next() )
{
if (0 != bx::memCmp(&_lhs[it.idx], &_rhs[it.idx], sizeof(Binding) ) )
{
return false;
}
}
return true;
}
struct Stream
{
void clear()
{
m_startVertex = 0;
m_handle = BGFX_INVALID_HANDLE;
m_layoutHandle = BGFX_INVALID_HANDLE;
}
uint32_t m_startVertex;
VertexBufferHandle m_handle;
VertexLayoutHandle m_layoutHandle;
};
BX_ALIGN_DECL_CACHE_LINE(struct) RenderBind
{
void clear(uint8_t _flags = BGFX_DISCARD_ALL)
{
if (0 != (_flags & BGFX_DISCARD_BINDINGS) )
{
for (uint32_t ii = 0; ii < BGFX_CONFIG_MAX_TEXTURE_SAMPLERS; ++ii)
{
Binding& bind = m_bind[ii];
bind.reset();
}
}
};
void clear(uint8_t _flags, uint32_t _mask)
{
if (0 != (_flags & BGFX_DISCARD_BINDINGS) )
{
for (BitMaskToIndexIteratorT<uint32_t> it(_mask); !it.isDone(); it.next() )
{
Binding& bind = m_bind[it.idx];
bind.reset();
}
}
};
Binding m_bind[BGFX_CONFIG_MAX_TEXTURE_SAMPLERS];
};
BX_ALIGN_DECL_CACHE_LINE(struct) RenderDraw
{
void clear(uint8_t _flags = BGFX_DISCARD_ALL)
{
if (0 != (_flags & BGFX_DISCARD_STATE) )
{
m_uniformBegin = 0;
m_uniformEnd = 0;
m_uniformIdx = UINT8_MAX;
m_stateFlags = BGFX_STATE_DEFAULT;
m_stencil = packStencil(BGFX_STENCIL_NONE, BGFX_STENCIL_NONE);
m_rgba = 0;
m_sampleMask = UINT32_MAX;
m_scissor = UINT16_MAX;
m_depthBias = UINT16_MAX;
}
if (0 != (_flags & BGFX_DISCARD_TRANSFORM) )
{
m_startMatrix = 0;
m_numMatrices = 1;
}
if (0 != (_flags & BGFX_DISCARD_INSTANCE_DATA) )
{
m_instanceDataOffset = 0;
m_instanceDataStride = 0;
m_numInstances = 1;
m_instanceDataBuffer = BGFX_INVALID_HANDLE;
}
if (0 != (_flags & BGFX_DISCARD_VERTEX_STREAMS) )
{
m_numVertices = UINT32_MAX;
m_streamMask = 0;
m_stream[0].clear();
}
if (0 != (_flags & BGFX_DISCARD_INDEX_BUFFER) )
{
m_startIndex = 0;
m_numIndices = UINT32_MAX;
m_indexBuffer = BGFX_INVALID_HANDLE;
m_submitFlags = 0;
}
else
{
m_submitFlags = isIndex16() ? 0 : BGFX_SUBMIT_INTERNAL_INDEX32;
}
m_startIndirect = 0;
m_numIndirect = UINT32_MAX;
m_numIndirectIndex = 0;
m_indirectBuffer = BGFX_INVALID_HANDLE;
m_numIndirectBuffer = BGFX_INVALID_HANDLE;
m_occlusionQuery = BGFX_INVALID_HANDLE;
m_bindIdx = 0;
}
bool setStreamBit(uint8_t _stream, VertexBufferHandle _handle)
{
const uint32_t bit = 1<<_stream;
const uint32_t mask = m_streamMask & ~bit;
const uint32_t tmp = isValid(_handle) ? bit : 0;
m_streamMask = mask | tmp;
return 0 != tmp;
}
bool isIndex16() const
{
return 0 == (m_submitFlags & BGFX_SUBMIT_INTERNAL_INDEX32);
}
Stream m_stream[BGFX_CONFIG_MAX_VERTEX_STREAMS];
uint64_t m_stateFlags;
uint64_t m_stencil;
uint32_t m_rgba;
uint32_t m_sampleMask;
uint32_t m_uniformBegin;
uint32_t m_uniformEnd;
uint32_t m_startMatrix;
uint32_t m_startIndex;
uint32_t m_numIndices;
uint32_t m_numVertices;
uint32_t m_instanceDataOffset;
uint32_t m_numInstances;
uint32_t m_startIndirect;
uint32_t m_numIndirect;
uint32_t m_numIndirectIndex;
uint32_t m_streamMask;
uint32_t m_bindIdx;
uint16_t m_instanceDataStride;
uint16_t m_numMatrices;
uint16_t m_scissor;
uint8_t m_submitFlags;
uint8_t m_uniformIdx;
IndexBufferHandle m_indexBuffer;
VertexBufferHandle m_instanceDataBuffer;
IndirectBufferHandle m_indirectBuffer;
IndexBufferHandle m_numIndirectBuffer;
OcclusionQueryHandle m_occlusionQuery;
uint16_t m_depthBias; // depth-bias cache index (UINT16_MAX = use view)
};
BX_ALIGN_DECL_CACHE_LINE(struct) RenderCompute
{
void clear(uint8_t _flags)
{
if (0 != (_flags & BGFX_DISCARD_STATE) )
{
m_uniformBegin = 0;
m_uniformEnd = 0;
m_uniformIdx = UINT8_MAX;
}
if (0 != (_flags & BGFX_DISCARD_TRANSFORM) )
{
m_startMatrix = 0;
m_numMatrices = 0;
}
m_numX = 0;
m_numY = 0;
m_numZ = 0;
m_submitFlags = 0;
m_indirectBuffer = BGFX_INVALID_HANDLE;
m_startIndirect = 0;
m_numIndirect = UINT32_MAX;
m_bindIdx = 0;
m_startIndex = 0;
}
uint32_t m_uniformBegin;
uint32_t m_uniformEnd;
uint32_t m_startMatrix;
uint32_t m_startIndex;
IndirectBufferHandle m_indirectBuffer;
uint32_t m_numX;
uint32_t m_numY;
uint32_t m_numZ;
uint32_t m_startIndirect;
uint32_t m_numIndirect;
uint32_t m_bindIdx;
uint16_t m_numMatrices;
uint8_t m_submitFlags;
uint8_t m_uniformIdx;
};
union RenderItem
{
RenderDraw draw;
RenderCompute compute;
};
BX_ALIGN_DECL_CACHE_LINE(struct) BlitItem
{
uint16_t m_srcX = 0;
uint16_t m_srcY = 0;
uint16_t m_srcZ = 0;
uint16_t m_dstX = 0;
uint16_t m_dstY = 0;
uint16_t m_dstZ = 0;
uint16_t m_width = 0;
uint16_t m_height = 0;
uint16_t m_depth = 0;
uint8_t m_srcMip = 0;
uint8_t m_dstMip = 0;
uint32_t m_srcOffset = 0;
uint32_t m_dstOffset = 0;
uint32_t m_size = 0;
uint32_t m_rowPitch = 0;
uint32_t m_slicePitch = 0;
Handle m_src = {};
Handle m_dst = {};
ViewId m_view = 0;
};
struct IndexBuffer
{
bx::FixedString64 m_name;
uint32_t m_size;
uint16_t m_flags;
};
struct VertexBuffer
{
bx::FixedString64 m_name;
uint32_t m_size;
uint16_t m_stride;
uint16_t m_flags;
VertexLayoutHandle m_layoutHandle = BGFX_INVALID_HANDLE;
};
struct BufferRef
{
Handle m_handle;
uint32_t m_offset;
uint32_t m_size;
uint16_t m_flags;
const bx::FixedString64* m_name;
};
inline bool isBufferReadable(uint16_t _flags)
{
return 0 != (_flags & (BGFX_BUFFER_COMPUTE_READ_WRITE|BGFX_BUFFER_DRAW_INDIRECT) );
}
inline bool isBufferWritable(uint16_t _flags)
{
return 0 != (_flags & (BGFX_BUFFER_COMPUTE_WRITE|BGFX_BUFFER_DRAW_INDIRECT) );
}
inline uint32_t calcTextureRegionPitch(TextureFormat::Enum _format, uint32_t _width)
{
const bimg::ImageBlockInfo& blockInfo = bimg::getBlockInfo(bimg::TextureFormat::Enum(_format) );
const uint32_t blockWidth = bx::max<uint32_t>(1, blockInfo.blockWidth);
return ( (_width + blockWidth - 1) / blockWidth) * blockInfo.blockSize;
}
inline uint32_t calcTextureRegionNumRows(TextureFormat::Enum _format, uint32_t _height)
{
const bimg::ImageBlockInfo& blockInfo = bimg::getBlockInfo(bimg::TextureFormat::Enum(_format) );
const uint32_t blockHeight = bx::max<uint32_t>(1, blockInfo.blockHeight);
return (_height + blockHeight - 1) / blockHeight;
}
inline uint32_t calcTextureRegionSize(TextureFormat::Enum _format, uint32_t _width, uint32_t _height, uint32_t _depth)
{
return calcTextureRegionPitch(_format, _width)
* calcTextureRegionNumRows(_format, _height)
* bx::max<uint32_t>(1, _depth)
;
}
inline void calcTextureRegionTexelPitch(uint32_t& _rowLength, uint32_t& _imageHeight, TextureFormat::Enum _format, uint32_t _rowPitch, uint32_t _slicePitch)
{
const bimg::ImageBlockInfo& blockInfo = bimg::getBlockInfo(bimg::TextureFormat::Enum(_format) );
_rowLength = (_rowPitch / blockInfo.blockSize) * bx::max<uint32_t>(1, blockInfo.blockWidth);
_imageHeight = (_slicePitch / _rowPitch) * bx::max<uint32_t>(1, blockInfo.blockHeight);
}
struct DynamicIndexBuffer
{
void reset()
{
m_handle = BGFX_INVALID_HANDLE;
m_offset = 0;
m_size = 0;
m_startIndex = 0;
m_flags = 0;
}
IndexBufferHandle m_handle;
uint32_t m_offset;
uint32_t m_size;
uint32_t m_startIndex;
uint16_t m_flags;
};
struct DynamicVertexBuffer
{
void reset()
{
m_handle = BGFX_INVALID_HANDLE;
m_offset = 0;
m_size = 0;
m_startVertex = 0;
m_numVertices = 0;
m_stride = 0;
m_layoutHandle = BGFX_INVALID_HANDLE;
m_flags = 0;
}
VertexBufferHandle m_handle;
uint32_t m_offset;
uint32_t m_size;
uint32_t m_startVertex;
uint32_t m_numVertices;
uint16_t m_stride;
VertexLayoutHandle m_layoutHandle = BGFX_INVALID_HANDLE;
uint16_t m_flags;
};
struct ShaderRef
{
UniformHandle* m_uniforms;
bx::FixedString64 m_name;
uint32_t m_hashIn;
uint32_t m_hashOut;
uint16_t m_num;
int16_t m_refCount;
uint16_t m_samplerUniform[BGFX_CONFIG_MAX_TEXTURE_SAMPLERS];
uint8_t m_samplerDimension[BGFX_CONFIG_MAX_TEXTURE_SAMPLERS];
uint8_t m_numSamplers;
};
struct ProgramRef
{
ShaderHandle m_vsh;
ShaderHandle m_fsh;
int16_t m_refCount;
};
struct UniformRef
{
bx::FixedString64 m_name;
UniformFreq::Enum m_freq;
UniformType::Enum m_type;
uint16_t m_num;
int16_t m_refCount;
};
struct TextureRef
{
void init(
BackbufferRatio::Enum _ratio
, uint16_t _width
, uint16_t _height
, uint16_t _depth
, TextureFormat::Enum _format
, uint32_t _storageSize
, uint8_t _numMips
, uint16_t _numLayers
, bool _ptrPending
, bool _immutable
, bool _cubeMap
, uint64_t _flags
)
{
m_ptr = _ptrPending ? (void*)UINTPTR_MAX : NULL;
m_storageSize = _storageSize;
m_refCount = 1;
m_bbRatio = uint8_t(_ratio);
m_width = _width;
m_height = _height;
m_depth = _depth;
m_format = uint8_t(_format);
m_numSamples = 1 << bx::satSub<uint32_t>(uint32_t( (_flags & BGFX_TEXTURE_RT_MSAA_MASK) >> BGFX_TEXTURE_RT_MSAA_SHIFT), 1u);
m_numMips = _numMips;
m_numLayers = _numLayers;
m_owned = false;
m_immutable = _immutable;
m_cubeMap = _cubeMap;
m_flags = _flags;
}
bool isRt() const
{
return 0 != (m_flags & BGFX_TEXTURE_RT_MASK);
}
bool isReadBack() const
{
return 0 != (m_flags & BGFX_TEXTURE_READ_BACK);
}
bool isBlitDst() const
{
return 0 != (m_flags & BGFX_TEXTURE_BLIT_DST);
}
bool isCubeMap() const
{
return m_cubeMap;
}
bool is3D() const
{
return 0 < m_depth;
}
bool isDepth() const
{
return bimg::isDepth(bimg::TextureFormat::Enum(m_format) );
}
bool hasMips() const
{
return 1 < m_numMips;
}
bx::FixedString64 m_name;
void* m_ptr;
uint64_t m_flags;
uint32_t m_storageSize;
int16_t m_refCount;
uint8_t m_bbRatio;
uint16_t m_width;
uint16_t m_height;
uint16_t m_depth;
uint8_t m_format;
uint8_t m_numSamples;
uint8_t m_numMips;
uint16_t m_numLayers;
bool m_owned;
bool m_immutable;
bool m_cubeMap;
};
struct FrameBufferRef
{
bx::FixedString64 m_name;
uint16_t m_width;
uint16_t m_height;
union un
{
TextureHandle m_th[BGFX_CONFIG_MAX_FRAME_BUFFER_ATTACHMENTS];
void* m_nwh;
} un;
SwapChain m_swapChain;
bool m_window;
};
struct DepthControl
{
int32_t m_constant;
float m_slopeScale;
float m_clamp;
bool m_depthClamp;
};
struct DepthControlCache
{
static_assert(BGFX_CONFIG_MAX_DEPTH_BIAS_CACHE <= UINT16_MAX
, "BGFX_CONFIG_MAX_DEPTH_BIAS_CACHE must leave UINT16_MAX free."
);
DepthControlCache()
: m_num(0)
, m_max(0)
{
}
void create(uint32_t _numMax)
{
m_max = _numMax;
m_cache.create(0, _numMax);
}
void destroy()
{
m_cache.destroy();
}
void reset()
{
m_num = 0;
}
void shrink(uint32_t _numItems)
{
m_cache.shrink(bx::min(m_max, _numItems) );
}
uint32_t add(int32_t _constant, float _slopeScale, float _clamp, bool _depthClamp)
{
const uint32_t first = bx::atomicFetchAndAddsat<uint32_t>(&m_num, 1, m_max);
BX_WARN(first < m_max
, "Exceeded number of available depth control values per frame. BGFX_CONFIG_MAX_DEPTH_BIAS_CACHE is %d."
, BGFX_CONFIG_MAX_DEPTH_BIAS_CACHE
);
if (first >= m_max)
{
return UINT16_MAX;
}
DepthControl& db = m_cache[first];
db.m_constant = _constant;
db.m_slopeScale = _slopeScale;
db.m_clamp = _clamp;
db.m_depthClamp = _depthClamp;
return first;
}
FrameArenaT<DepthControl, kDepthControlBlock> m_cache;
uint32_t m_num;
uint32_t m_max;
};
BX_ALIGN_DECL_CACHE_LINE(struct) View
{
void reset()
{
bx::memSet(this, 0, sizeof(View) );
setRect(0, 0, 1, 1);
setScissor(0, 0, 0, 0);
setClear(BGFX_CLEAR_NONE, 0, 0.0f, 0);
setShadingRate(ShadingRate::Rate1x1);
setFrameBuffer(BGFX_INVALID_HANDLE);
setTransform(NULL, NULL);
setDepthBias(0, 0.0f, 0.0f);
setSampleMask(UINT32_MAX);
}
void setRect(int16_t _x, int16_t _y, uint16_t _width, uint16_t _height, float _minDepth = 0.0f, float _maxDepth = 1.0f)
{
m_rect.m_x = _x;
m_rect.m_y = _y;
m_rect.m_width = bx::max<uint16_t>(_width, 1);
m_rect.m_height = bx::max<uint16_t>(_height, 1);
m_minDepth = _minDepth;
m_maxDepth = _maxDepth;
m_clippedRect = m_rect;
}
void setSampleMask(uint32_t _mask)
{
m_sampleMask = _mask;
}
void setDepthBias(int32_t _constant, float _slopeScale, float _clamp)
{
m_depthBias.m_constant = _constant;
m_depthBias.m_slopeScale = _slopeScale;
m_depthBias.m_clamp = _clamp;
m_depthBias.m_depthClamp = false;
}
void setScissor(uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height)
{
m_scissor.m_x = _x;
m_scissor.m_y = _y;
m_scissor.m_width = _width;
m_scissor.m_height = _height;
}
void setClear(uint16_t _flags, uint32_t _rgba, float _depth, uint8_t _stencil)
{
m_clear.set(_flags, _rgba, _depth, _stencil);
}
void setClear(uint16_t _flags, float _depth, uint8_t _stencil, uint8_t _0, uint8_t _1, uint8_t _2, uint8_t _3, uint8_t _4, uint8_t _5, uint8_t _6, uint8_t _7)
{
m_clear.set(_flags, _depth, _stencil, _0, _1, _2, _3, _4, _5, _6, _7);
}
void setShadingRate(ShadingRate::Enum _shadingRate)
{
m_shadingRate = uint8_t(_shadingRate);
}
void setUniform(UniformHandle _handle, const void* _value, uint16_t _num)
{
BX_UNUSED(_handle, _value, _num);
}
void setFrameBuffer(FrameBufferHandle _handle)
{
m_fbh = _handle;
}
void setTransform(const void* _view, const void* _proj)
{
if (NULL != _view)
{
bx::memCopy(m_view.un.val, _view, sizeof(Matrix4) );
}
else
{
m_view.setIdentity();
}
if (NULL != _proj)
{
bx::memCopy(m_proj.un.val, _proj, sizeof(Matrix4) );
}
else
{
m_proj.setIdentity();
}
}
Clear m_clear;
Rect m_rect;
Rect m_clippedRect;
Rect m_scissor;
Matrix4 m_view;
Matrix4 m_proj;
FrameBufferHandle m_fbh;
uint16_t m_nameIdx;
uint8_t m_shadingRate;
uint8_t m_mode;
float m_minDepth = 0.0f;
float m_maxDepth = 1.0f;
DepthControl m_depthBias;
uint32_t m_sampleMask;
};
template<typename Ty, uint32_t MaxT, uint32_t BlockT = 64>
class HandleArenaT
{
public:
static_assert(bx::isPowerOf2(BlockT), "HandleArenaT BlockT must be power of two.");
~HandleArenaT()
{
destroy();
}
#if BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
static constexpr uint32_t kBlockMask = BlockT - 1;
static constexpr uint32_t kNumBlocks = (MaxT + kBlockMask)/BlockT;
HandleArenaT()
{
bx::memSet(m_block, 0, sizeof(m_block) );
bx::memSet(m_numLive, 0, sizeof(m_numLive) );
bx::memSet(m_touched, 0, sizeof(m_touched) );
}
void destroy()
{
for (uint32_t ii = 0; ii < kNumBlocks; ++ii)
{
freeBlock(ii);
}
bx::memSet(m_numLive, 0, sizeof(m_numLive) );
bx::memSet(m_touched, 0, sizeof(m_touched) );
}
Ty& alloc(uint16_t _idx)
{
const uint32_t blockIdx = _idx / BlockT;
Ty* block = m_block[blockIdx];
if (NULL == block)
{
block = allocBlock(blockIdx);
}
m_numLive[blockIdx]++;
m_touched[blockIdx] = true;
return block[_idx & kBlockMask];
}
template<typename Fn>
void each(Fn _fn)
{
for (uint32_t ii = 0; ii < kNumBlocks; ++ii)
{
Ty* block = m_block[ii];
if (NULL != block)
{
for (uint32_t jj = 0; jj < BlockT; ++jj)
{
_fn(block[jj]);
}
}
}
}
uint16_t indexOf(const Ty& _ref) const
{
const Ty* ptr = &_ref;
for (uint32_t ii = 0; ii < kNumBlocks; ++ii)
{
const Ty* block = m_block[ii];
if (NULL != block
&& ptr >= block
&& ptr < block + BlockT)
{
return uint16_t(ii*BlockT + uint32_t(ptr - block) );
}
}
BX_ASSERT(false, "Element is not in arena.");
return UINT16_MAX;
}
void release(uint16_t _idx)
{
const uint32_t blockIdx = _idx / BlockT;
BX_ASSERT(0 < m_numLive[blockIdx], "Handle %d released more times than allocated.", _idx);
m_numLive[blockIdx]--;
}
BX_FORCE_INLINE Ty& operator[](uint16_t _idx)
{
return load(_idx / BlockT)[_idx & kBlockMask];
}
BX_FORCE_INLINE const Ty& operator[](uint16_t _idx) const
{
return load(_idx / BlockT)[_idx & kBlockMask];
}
void freeUnused()
{
for (uint32_t ii = 0; ii < kNumBlocks; ++ii)
{
if (0 == m_numLive[ii]
&& !m_touched[ii])
{
freeBlock(ii);
}
m_touched[ii] = false;
}
}
private:
BX_FORCE_INLINE Ty* load(uint32_t _blockIdx) const
{
return *(Ty* volatile*)&m_block[_blockIdx];
}
BX_NO_INLINE Ty* allocBlock(uint32_t _blockIdx)
{
Ty* block = (Ty*)bx::alloc(g_allocator, sizeof(Ty)*BlockT, BX_ALIGNOF(Ty) );
for (uint32_t ii = 0; ii < BlockT; ++ii)
{
BX_PLACEMENT_NEW(&block[ii], Ty);
}
bx::atomicExchangePtr( (void**)&m_block[_blockIdx], block);
return block;
}
BX_NO_INLINE void freeBlock(uint32_t _blockIdx)
{
Ty* block = m_block[_blockIdx];
if (NULL != block)
{
for (uint32_t ii = 0; ii < BlockT; ++ii)
{
block[ii].~Ty();
}
bx::free(g_allocator, block, BX_ALIGNOF(Ty) );
m_block[_blockIdx] = NULL;
}
}
Ty* m_block[kNumBlocks];
uint16_t m_numLive[kNumBlocks];
bool m_touched[kNumBlocks];
#else
void destroy()
{
}
Ty& alloc(uint16_t _idx)
{
return m_data[_idx];
}
void release(uint16_t /*_idx*/)
{
}
BX_FORCE_INLINE Ty& operator[](uint16_t _idx)
{
return m_data[_idx];
}
BX_FORCE_INLINE const Ty& operator[](uint16_t _idx) const
{
return m_data[_idx];
}
template<typename Fn>
void each(Fn _fn)
{
for (uint32_t ii = 0; ii < MaxT; ++ii)
{
_fn(m_data[ii]);
}
}
uint16_t indexOf(const Ty& _ref) const
{
return uint16_t(&_ref - m_data);
}
void freeUnused()
{
}
private:
Ty m_data[MaxT];
#endif // BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
};
class ViewArena
{
public:
~ViewArena()
{
destroy();
}
#if BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
static constexpr uint32_t kBlockMask = kViewBlock - 1;
static constexpr uint32_t kNumBlocks = bx::alignUp(BGFX_CONFIG_MAX_VIEWS, kViewBlock)/kViewBlock;
ViewArena()
: m_reserved(NULL)
, m_numReservedBlocks(0)
{
bx::memSet(m_block, 0, sizeof(m_block) );
m_default.reset();
}
void create(uint32_t _numReserved)
{
destroy();
m_numReservedBlocks = bx::min( (_numReserved + kBlockMask)/kViewBlock, kNumBlocks);
if (0 < m_numReservedBlocks)
{
m_reserved = alloc(m_numReservedBlocks*kViewBlock);
for (uint32_t ii = 0; ii < m_numReservedBlocks; ++ii)
{
m_block[ii] = m_reserved + ii*kViewBlock;
}
}
}
void destroy()
{
for (uint32_t ii = m_numReservedBlocks; ii < kNumBlocks; ++ii)
{
freeBlock(ii);
}
if (NULL != m_reserved)
{
bx::free(g_allocator, m_reserved, BX_ALIGNOF(View) );
m_reserved = NULL;
}
bx::memSet(m_block, 0, sizeof(m_block) );
m_numReservedBlocks = 0;
}
BX_FORCE_INLINE View& operator[](uint32_t _id)
{
const uint32_t blockIdx = _id / kViewBlock;
View* block = load(blockIdx);
if (NULL == block)
{
block = allocBlock(blockIdx);
}
return block[_id & kBlockMask];
}
BX_FORCE_INLINE View* find(uint32_t _id)
{
View* block = load(_id / kViewBlock);
return NULL != block
? &block[_id & kBlockMask]
: NULL
;
}
BX_FORCE_INLINE const View& get(uint32_t _id) const
{
const View* block = load(_id / kViewBlock);
return NULL != block
? block[_id & kBlockMask]
: m_default
;
}
BX_FORCE_INLINE const View& unset() const
{
return m_default;
}
void freeUnset()
{
for (uint32_t ii = m_numReservedBlocks; ii < kNumBlocks; ++ii)
{
const View* block = m_block[ii];
if (NULL != block)
{
bool unset = true;
for (uint32_t jj = 0; jj < kViewBlock && unset; ++jj)
{
unset = 0 == bx::memCmp(&block[jj], &m_default, sizeof(View) );
}
if (unset)
{
freeBlock(ii);
}
}
}
}
private:
static View* alloc(uint32_t _num)
{
View* view = (View*)bx::alloc(g_allocator, sizeof(View)*_num, BX_ALIGNOF(View) );
for (uint32_t ii = 0; ii < _num; ++ii)
{
view[ii].reset();
}
return view;
}
BX_FORCE_INLINE View* load(uint32_t _blockIdx) const
{
return *(View* volatile*)&m_block[_blockIdx];
}
BX_NO_INLINE View* allocBlock(uint32_t _blockIdx)
{
bx::MutexScope lock(m_lock);
View* block = m_block[_blockIdx];
if (NULL == block)
{
block = alloc(kViewBlock);
bx::atomicExchangePtr( (void**)&m_block[_blockIdx], block);
}
return block;
}
void freeBlock(uint32_t _blockIdx)
{
if (NULL != m_block[_blockIdx])
{
bx::free(g_allocator, m_block[_blockIdx], BX_ALIGNOF(View) );
m_block[_blockIdx] = NULL;
}
}
View* m_block[kNumBlocks];
View* m_reserved;
uint32_t m_numReservedBlocks;
View m_default;
bx::Mutex m_lock;
#else
ViewArena()
{
create(BGFX_CONFIG_MAX_VIEWS);
m_default.reset();
}
void create(uint32_t /*_numReserved*/)
{
for (uint32_t ii = 0; ii < BGFX_CONFIG_MAX_VIEWS; ++ii)
{
m_view[ii].reset();
}
}
void destroy()
{
}
BX_FORCE_INLINE View& operator[](uint32_t _id)
{
return m_view[_id];
}
BX_FORCE_INLINE View* find(uint32_t _id)
{
return &m_view[_id];
}
BX_FORCE_INLINE const View& get(uint32_t _id) const
{
return m_view[_id];
}
BX_FORCE_INLINE const View& unset() const
{
return m_default;
}
void freeUnset()
{
}
private:
View m_view[BGFX_CONFIG_MAX_VIEWS];
View m_default;
#endif // BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
};
class ViewNameArena
{
public:
static constexpr uint32_t kBlock = 64;
static constexpr uint32_t kBlockMask = kBlock - 1;
static constexpr uint32_t kNumNames = BGFX_CONFIG_MAX_VIEWS + 1;
static constexpr uint32_t kNumBlocks = (kNumNames + kBlockMask)/kBlock;
static constexpr uint32_t kNameSize = BGFX_CONFIG_MAX_VIEW_NAME;
void create()
{
m_alloc.reset();
m_alloc.alloc();
bx::memSet(m_touched, 0, sizeof(m_touched) );
}
void destroy()
{
#if BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
for (uint32_t ii = 0; ii < kNumBlocks; ++ii)
{
freeBlock(ii);
}
#endif // BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
}
uint16_t alloc()
{
const uint16_t idx = m_alloc.alloc();
if (bx::kInvalidHandle == idx
|| idx >= kNumNames)
{
BX_ASSERT(false, "Out of view names.");
m_alloc.free(idx);
return 0;
}
const uint32_t blockIdx = idx / kBlock;
#if BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
if (NULL == m_block[blockIdx])
{
char* block = (char*)bx::alloc(g_allocator, kBlock*kNameSize);
bx::memSet(block, 0, kBlock*kNameSize);
bx::atomicExchangePtr( (void**)&m_block[blockIdx], block);
}
#endif // BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
m_touched[blockIdx] = true;
return idx;
}
void free(uint16_t _idx)
{
m_alloc.free(_idx);
}
const char* get(uint16_t _idx) const
{
#if BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
const char* block = *(char* volatile*)&m_block[_idx / kBlock];
if (NULL == block)
{
return "";
}
#else
const char* block = m_name[_idx / kBlock];
#endif // BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
return &block[(_idx & kBlockMask)*kNameSize];
}
char* data(uint16_t _idx)
{
BX_ASSERT(0 != _idx, "View name 0 is the unset name.");
return const_cast<char*>(get(_idx) );
}
void freeUnused()
{
for (uint32_t ii = 1; ii < kNumBlocks; ++ii)
{
if (m_alloc.getBits().testNone(ii*kBlock, (ii+1)*kBlock)
&& !m_touched[ii])
{
#if BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
freeBlock(ii);
#endif // BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
}
m_touched[ii] = false;
}
}
private:
#if BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
void freeBlock(uint32_t _blockIdx)
{
if (NULL != m_block[_blockIdx])
{
bx::free(g_allocator, m_block[_blockIdx]);
m_block[_blockIdx] = NULL;
}
}
char* m_block[kNumBlocks] = {};
#else
char m_name[kNumBlocks][kBlock*kNameSize] = {};
#endif // BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
bool m_touched[kNumBlocks];
bx::HandleAlloc2T<kNumBlocks*kBlock> m_alloc;
};
struct UniformCacheKey
{
using KeyT = uint64_t;
static constexpr uint8_t kViewShift = sizeof(KeyT)*8-16;
static constexpr KeyT kViewMask = KeyT(UINT16_MAX)<<kViewShift;
static constexpr uint8_t kHandleShift = kViewShift - 16;
static constexpr KeyT kHandleMask = KeyT(UINT16_MAX)<<kHandleShift;
static constexpr uint8_t kOffsetShift = kHandleShift-20;
static constexpr KeyT kOffsetMask = KeyT(UINT32_MAX>>12)<<kOffsetShift;
static constexpr uint8_t kSizeShift = kOffsetShift-12;
static constexpr KeyT kSizeMask = KeyT(UINT16_MAX>>4)<<kSizeShift;
static_assert( (0
| kViewMask
| kHandleMask
| kOffsetMask
| kSizeMask
) == (0
^ kViewMask
^ kHandleMask
^ kOffsetMask
^ kSizeMask
), "UniformCacheKey: Key mask shouldn't overlap!");
KeyT encode()
{
static constexpr uint32_t kMaxSize = ( (kSizeMask >>kSizeShift ) + 1)<<4;
static constexpr uint32_t kMaxOffset = ( (kOffsetMask>>kOffsetShift) + 1)<<4;
BX_ASSERT(true
&& uint32_t(m_size) < kMaxSize
&& m_offset < kMaxOffset
, "UniformCacheKey couldn't fit size or offest (size %d max %d, offset %d max %d)!"
, m_size
, kMaxSize
, m_offset
, kMaxOffset
);
BX_ASSERT(true
&& 0 == (m_size & 0xf)
&& 0 == (m_offset & 0xf)
, "UniformCacheKey size and offset must be 16 byte aligned (size %d, offset %d)!"
, m_size
, m_offset
);
BX_UNUSED(kMaxSize, kMaxOffset);
const KeyT view = (KeyT(m_view) << kViewShift) & kViewMask;
const KeyT handle = (KeyT(m_handle) << kHandleShift) & kHandleMask;
const KeyT offset = (KeyT(m_offset>>4) << kOffsetShift) & kOffsetMask;
const KeyT size = (KeyT(m_size>>4) << kSizeShift) & kSizeMask;
const KeyT key = view|handle|offset|size;
return key;
}
void decode(KeyT _key)
{
m_offset = (uint32_t( (_key & kOffsetMask) >> kOffsetShift) ) << 4;
m_handle = {uint16_t( (_key & kHandleMask) >> kHandleShift) };
m_size = (uint16_t( (_key & kSizeMask) >> kSizeShift ) ) << 4;
m_view = ViewId( (_key & kViewMask) >> kViewShift);
}
static KeyT remapView(KeyT _key, ViewId _viewRemap[BGFX_CONFIG_MAX_VIEWS])
{
const ViewId oldView = ViewId( (_key & kViewMask) >> kViewShift);
const KeyT view = UINT16_MAX != oldView
? (KeyT(_viewRemap[oldView]) << kViewShift) & kViewMask
: 0 // frame uniforms go into physical view 0.
;
const KeyT key = (_key & ~kViewMask) | view;
return key;
}
uint32_t m_offset;
uint16_t m_handle;
uint16_t m_size;
ViewId m_view;
};
struct UniformCacheEntry
{
uint32_t offset;
uint16_t size;
int16_t refCount;
};
struct UniformCacheFrame
{
static constexpr uint32_t kMinKeysCapacity = 256;
static constexpr uint32_t kMinDataCapacity = 16<<10;
UniformCacheFrame()
: m_keys(NULL)
, m_data(NULL)
, m_numItems(0)
, m_keysCapacity(kMinKeysCapacity)
, m_dataCapacity(kMinDataCapacity)
{
m_keys = (UniformCacheKey::KeyT*)bx::alloc(g_allocator, (m_keysCapacity+1)*sizeof(uint64_t) );
m_data = (uint8_t*)bx::alloc(g_allocator, m_dataCapacity);
m_keys[0] = 0;
}
~UniformCacheFrame()
{
bx::free(g_allocator, m_keys);
bx::free(g_allocator, m_data);
}
void resize(uint32_t _keysCapacity, uint32_t _dataCapacity)
{
{
const uint32_t newKeysCapacity = bx::alignUp(bx::max(_keysCapacity, kMinKeysCapacity), kMinKeysCapacity);
if (newKeysCapacity != m_keysCapacity)
{
m_keys = (UniformCacheKey::KeyT*)bx::realloc(g_allocator, m_keys, (newKeysCapacity+1) * sizeof(uint64_t));
m_keysCapacity = newKeysCapacity;
}
}
{
const uint32_t newDataCapacity = bx::alignUp(bx::max(_dataCapacity, kMinDataCapacity), kMinDataCapacity);
if (newDataCapacity != m_dataCapacity)
{
m_data = (uint8_t*)bx::realloc(g_allocator, m_data, newDataCapacity);
m_dataCapacity = newDataCapacity;
}
}
}
void sort(ViewId* _viewRemap, uint64_t* _tempKeys)
{
for (uint32_t ii = 0, num = m_numItems; ii < num; ++ii)
{
m_keys[ii] = UniformCacheKey::remapView(m_keys[ii], _viewRemap);
}
bx::radixSort(m_keys, _tempKeys, m_numItems);
}
uint64_t* m_keys;
uint8_t* m_data;
uint32_t m_numItems;
uint32_t m_keysCapacity;
uint32_t m_dataCapacity;
};
struct FrameCache
{
void create(uint32_t _numReservedMatrices, uint32_t _numMaxMatrices, uint32_t _numHwmFrames)
{
m_matrixCache.create(_numReservedMatrices, _numMaxMatrices, _numHwmFrames);
m_rectCache.create(BGFX_CONFIG_MAX_RECT_CACHE);
m_depthBiasCache.create(BGFX_CONFIG_MAX_DEPTH_BIAS_CACHE);
}
void destroy()
{
m_matrixCache.destroy();
m_rectCache.destroy();
m_depthBiasCache.destroy();
}
void reset()
{
m_matrixCache.reset();
m_rectCache.reset();
m_depthBiasCache.reset();
}
bool isZeroArea(const Rect& _rect, uint16_t _scissor) const
{
if (UINT16_MAX != _scissor)
{
Rect scissorRect;
scissorRect.setIntersect(_rect, m_rectCache.m_cache[_scissor]);
return scissorRect.isZeroArea();
}
return false;
}
MatrixCache m_matrixCache;
RectCache m_rectCache;
DepthControlCache m_depthBiasCache;
};
struct ScreenShot
{
bx::FilePath filePath;
FrameBufferHandle handle;
};
template<typename Ty, uint32_t Max>
struct FreeHandle
{
FreeHandle()
: m_num(0)
{
}
bool isQueued(Ty _handle)
{
for (uint32_t ii = 0, num = m_num; ii < num; ++ii)
{
if (m_queue[ii].idx == _handle.idx)
{
return true;
}
}
return false;
}
bool queue(Ty _handle)
{
if (BX_ENABLED(BGFX_CONFIG_DEBUG) )
{
if (isQueued(_handle) )
{
return false;
}
}
reserve(m_num + 1);
m_queue[m_num] = _handle;
++m_num;
return true;
}
void reset()
{
m_num = 0;
}
Ty get(uint16_t _idx) const
{
return m_queue[_idx];
}
uint16_t getNumQueued() const
{
return m_num;
}
#if BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
~FreeHandle()
{
bx::free(g_allocator, m_queue);
}
private:
void reserve(uint32_t _num)
{
if (_num > m_capacity)
{
m_capacity = bx::min<uint32_t>(bx::alignUp(_num, 64), Max);
m_queue = (Ty*)bx::realloc(g_allocator, m_queue, sizeof(Ty)*m_capacity);
}
}
Ty* m_queue = NULL;
uint32_t m_capacity = 0;
#else
private:
void reserve(uint32_t /*_num*/)
{
}
Ty m_queue[Max];
#endif // BGFX_CONFIG_DYNAMIC_FRAME_STORAGE
uint16_t m_num;
};
BX_ALIGN_DECL_CACHE_LINE(struct) Frame
{
Frame()
: m_sortKeys(NULL)
, m_sortValues(NULL)
, m_blitKeys(NULL)
, m_blitKeysCapacity(0)
, m_maxDrawCalls(0)
, m_numRenderItemsRequested(0)
, m_peak(0)
, m_peakBlit(0)
, m_peakRect(0)
, m_peakDepthBias(0)
, m_observe(0)
, m_numPeakFrames(0)
, m_viewStats(NULL)
, m_numViewStats(0)
, m_waitSubmit(0)
, m_waitRender(0)
, m_frameNum(0)
, m_capture(false)
, m_flush(false)
, m_needBindDedup(false)
, m_numUsedViews(0)
, m_peakViews(0)
{
m_numRenderItems = 0;
m_numRenderBinds = 0;
bx::memSet(m_occlusion, 0xff, sizeof(m_occlusion) );
bx::memSet(m_viewUsed, 0, sizeof(m_viewUsed) );
bx::memSet(m_viewUsedOffset, 0, sizeof(m_viewUsedOffset) );
m_perfStats.viewStats = m_viewStats;
}
~Frame()
{
m_frameCache.destroy();
freeArrays();
}
void allocArrays(uint32_t _numReservedDrawCalls, uint32_t _maxDrawCalls)
{
freeArrays();
m_maxDrawCalls = _maxDrawCalls;
const uint32_t reserved = bx::min(_numReservedDrawCalls, _maxDrawCalls) + 1;
const uint32_t num = m_maxDrawCalls + 1;
m_sortKeys = (uint64_t* )bx::alloc(g_allocator, sizeof(uint64_t )*num);
m_sortValues = (RenderItemCount*)bx::alloc(g_allocator, sizeof(RenderItemCount)*num);
m_renderItem.create(reserved, num);
m_renderBind.create(reserved, num);
m_view.create(kViewBlock, BGFX_CONFIG_MAX_VIEWS);
m_blitItem.create(0, BGFX_CONFIG_MAX_BLIT_ITEMS);
reserveBlitKeys(0);
setSentinel();
}
void reserveBlitKeys(uint32_t _num)
{
const uint32_t capacity = bx::alignUp(_num+1, 64);
if (m_blitKeysCapacity < capacity)
{
bx::free(g_allocator, m_blitKeys);
m_blitKeys = (uint32_t*)bx::alloc(g_allocator, sizeof(uint32_t)*capacity);
m_blitKeysCapacity = capacity;
}
m_blitKeys[_num] = 0;
}
void reserveViewStats(bool _enable, uint32_t _num)
{
if (!_enable)
{
bx::free(g_allocator, m_viewStats);
m_viewStats = NULL;
m_numViewStats = 0;
}
else if (m_numViewStats < _num)
{
bx::free(g_allocator, m_viewStats);
m_numViewStats = bx::alignUp(_num, kViewBlock);
m_viewStats = (ViewStats*)bx::alloc(g_allocator, sizeof(ViewStats)*m_numViewStats);
}
m_perfStats.viewStats = m_viewStats;
}
void freeArrays()
{
bx::free(g_allocator, m_sortKeys);
bx::free(g_allocator, m_sortValues);
bx::free(g_allocator, m_blitKeys);
m_sortKeys = NULL;
m_sortValues = NULL;
m_blitKeys = NULL;
m_blitKeysCapacity = 0;
reserveViewStats(false, 0);
m_view.destroy();
m_renderItem.destroy();
m_renderBind.destroy();
m_blitItem.destroy();
}
void setSentinel()
{
SortKey term;
term.reset();
term.m_program = BGFX_INVALID_HANDLE;
m_sortKeys[m_maxDrawCalls] = term.encodeDraw(SortKey::SortProgram);
m_sortValues[m_maxDrawCalls] = RenderItemCount(m_maxDrawCalls);
}
void adjustCapacity()
{
if (0 == m_numPeakFrames)
{
return;
}
m_peak = bx::max(m_peak, m_numRenderItemsRequested, m_numRenderBinds);
m_peakBlit = bx::max(m_peakBlit, m_numBlitItems);
m_peakRect = bx::max(m_peakRect, m_frameCache.m_rectCache.m_num);
m_peakDepthBias = bx::max(m_peakDepthBias, m_frameCache.m_depthBiasCache.m_num);
m_peakViews = bx::max<uint32_t>(m_peakViews, m_numUsedViews);
if (++m_observe >= m_numPeakFrames)
{
const uint32_t keep = bx::min<uint32_t>(m_maxDrawCalls + 1, m_peak + 1 + kDrawCallBlock);
m_renderItem.shrink(keep);
m_renderBind.shrink(keep);
m_blitItem.shrink(m_peakBlit + 1 + kBlitBlock);
m_frameCache.m_rectCache.shrink(m_peakRect + 1 + kRectBlock);
m_frameCache.m_depthBiasCache.shrink(m_peakDepthBias + 1 + kDepthControlBlock);
m_view.shrink(m_peakViews + kViewBlock);
m_cmdPre.shrink();
m_cmdPost.shrink();
for (uint32_t ii = 0, num = g_caps.limits.maxEncoders; ii < num; ++ii)
{
if (NULL != m_uniformBuffer[ii])
{
UniformBuffer::shrink(&m_uniformBuffer[ii], g_caps.limits.minUniformBufferSize);
}
}
m_peak = 0;
m_peakBlit = 0;
m_peakRect = 0;
m_peakDepthBias = 0;
m_peakViews = 0;
m_observe = 0;
}
}
void create(uint32_t _minResourceCbSize, uint32_t _numReservedDrawCalls, uint32_t _maxDrawCalls, uint32_t _numHwmFrames)
{
m_cmdPre.init(_minResourceCbSize);
m_cmdPost.init(_minResourceCbSize);
m_numPeakFrames = _numHwmFrames;
allocArrays(_numReservedDrawCalls, _maxDrawCalls);
m_frameCache.create(_numReservedDrawCalls + 1, _maxDrawCalls + 1, _numHwmFrames);
{
const uint32_t num = g_caps.limits.maxEncoders;
m_uniformBuffer = (UniformBuffer**)bx::alloc(g_allocator, sizeof(UniformBuffer*)*num);
bx::memSet(m_uniformBuffer, 0, sizeof(UniformBuffer*)*num);
}
reset();
start(0);
m_textVideoMem = NULL;
if (BX_ENABLED(BGFX_CONFIG_DEBUG_TEXT) )
{
m_textVideoMem = BX_NEW(g_allocator, TextVideoMem);
}
}
void destroy()
{
for (uint32_t ii = 0, num = g_caps.limits.maxEncoders; ii < num; ++ii)
{
if (NULL != m_uniformBuffer[ii])
{
UniformBuffer::destroy(m_uniformBuffer[ii]);
}
}
bx::free(g_allocator, m_uniformBuffer);
bx::deleteObject(g_allocator, m_textVideoMem);
}
UniformBuffer* getUniformBuffer(uint8_t _idx)
{
UniformBuffer*& uniformBuffer = m_uniformBuffer[_idx];
if (NULL == uniformBuffer)
{
uniformBuffer = UniformBuffer::create(g_caps.limits.minUniformBufferSize);
}
return uniformBuffer;
}
void reset()
{
start(0);
finish();
resetFreeHandles();
}
void start(uint32_t frameNum)
{
m_perfStats.transientVbUsed = m_vboffset;
m_perfStats.transientIbUsed = m_iboffset;
adjustCapacity();
m_frameCache.reset();
m_numRenderItems = 0;
m_numRenderBinds = 0;
m_numBlitItems = 0;
m_numBlitRepack = 0;
m_iboffset = 0;
m_vboffset = 0;
m_cmdPre.start();
m_cmdPost.start();
m_capture = false;
m_flush = false;
m_numScreenShots = 0;
m_frameNum = frameNum;
m_numUsedViews = 0;
bx::memSet(m_viewUsed, 0, sizeof(m_viewUsed) );
}
void collectUsedViews()
{
uint16_t num = 0;
for (uint32_t ww = 0; ww < kViewUsedWords; ++ww)
{
m_viewUsedOffset[ww] = num;
num += uint16_t(bx::countBits(m_viewUsed[ww]) );
}
m_numUsedViews = num;
}
void finish()
{
m_cmdPre.finish();
m_cmdPost.finish();
}
void sort();
void dedupBind();
uint32_t getAvailTransientIndexBuffer(uint32_t _num, uint16_t _indexSize)
{
const uint32_t offset = bx::strideAlign(m_iboffset, _indexSize);
uint32_t iboffset = offset + _num*_indexSize;
iboffset = bx::min<uint32_t>(iboffset, g_caps.limits.maxTransientIbSize);
const uint32_t num = (iboffset-offset)/_indexSize;
return num;
}
uint32_t allocTransientIndexBuffer(uint32_t& _num, uint16_t _indexSize)
{
uint32_t offset = bx::strideAlign(m_iboffset, _indexSize);
uint32_t num = getAvailTransientIndexBuffer(_num, _indexSize);
m_iboffset = offset + num*_indexSize;
_num = num;
return offset;
}
uint32_t getAvailTransientVertexBuffer(uint32_t _num, uint16_t _stride)
{
uint32_t offset = bx::strideAlign(m_vboffset, _stride);
uint32_t vboffset = offset + _num * _stride;
vboffset = bx::min<uint32_t>(vboffset, g_caps.limits.maxTransientVbSize);
uint32_t num = (vboffset-offset)/_stride;
return num;
}
uint32_t allocTransientVertexBuffer(uint32_t& _num, uint16_t _stride)
{
uint32_t offset = bx::strideAlign(m_vboffset, _stride);
uint32_t num = getAvailTransientVertexBuffer(_num, _stride);
m_vboffset = offset + num * _stride;
_num = num;
return offset;
}
bool free(IndexBufferHandle _handle)
{
return m_freeIndexBuffer.queue(_handle);
}
bool free(VertexLayoutHandle _handle)
{
return m_freeVertexLayout.queue(_handle);
}
bool free(VertexBufferHandle _handle)
{
return m_freeVertexBuffer.queue(_handle);
}
bool free(ShaderHandle _handle)
{
return m_freeShader.queue(_handle);
}
bool free(ProgramHandle _handle)
{
return m_freeProgram.queue(_handle);
}
bool free(TextureHandle _handle)
{
return m_freeTexture.queue(_handle);
}
bool free(FrameBufferHandle _handle)
{
return m_freeFrameBuffer.queue(_handle);
}
bool free(UniformHandle _handle)
{
return m_freeUniform.queue(_handle);
}
void resetFreeHandles()
{
m_freeIndexBuffer.reset();
m_freeVertexLayout.reset();
m_freeVertexBuffer.reset();
m_freeShader.reset();
m_freeProgram.reset();
m_freeTexture.reset();
m_freeFrameBuffer.reset();
m_freeUniform.reset();
}
ViewId m_viewRemap[BGFX_CONFIG_MAX_VIEWS];
ViewId m_viewOrder[BGFX_CONFIG_MAX_VIEWS+1]; //!< Inverse of m_viewRemap.
float m_colorPalette[BGFX_CONFIG_MAX_COLOR_PALETTE][4];
FrameArenaT<View, kViewBlock> m_view;
const View& view(ViewId _id) const;
int32_t m_occlusion[BGFX_CONFIG_MAX_OCCLUSION_QUERIES];
FrameArenaT<RenderItem, kDrawCallBlock> m_renderItem;
FrameArenaT<RenderBind, kDrawCallBlock> m_renderBind;
FrameArenaT<BlitItem, kBlitBlock> m_blitItem;
uint64_t* m_sortKeys;
RenderItemCount* m_sortValues;
uint32_t* m_blitKeys;
uint32_t m_blitKeysCapacity;
uint32_t m_maxDrawCalls;
uint32_t m_numRenderItemsRequested;
uint32_t m_peak;
uint32_t m_peakBlit;
uint32_t m_peakRect;
uint32_t m_peakDepthBias;
uint32_t m_observe;
uint32_t m_numPeakFrames;
UniformCacheFrame m_uniformCacheFrame;
FrameCache m_frameCache;
UniformBuffer** m_uniformBuffer;
uint32_t m_numRenderItems;
uint32_t m_numRenderBinds;
uint32_t m_numBlitItems;
uint32_t m_numBlitRepack;
uint32_t m_iboffset;
uint32_t m_vboffset;
TransientIndexBuffer* m_transientIb;
TransientVertexBuffer* m_transientVb;
SwapChain m_mainSwapChain;
uint32_t m_reset;
uint32_t m_debug;
FrameBufferHandle m_debugFrameBuffer;
uint8_t m_debugTextScale;
ScreenShot m_screenShot[BGFX_CONFIG_MAX_SCREENSHOTS];
uint8_t m_numScreenShots;
CommandBuffer m_cmdPre;
CommandBuffer m_cmdPost;
FreeHandle<IndexBufferHandle, BGFX_CONFIG_MAX_INDEX_BUFFERS> m_freeIndexBuffer;
FreeHandle<VertexLayoutHandle, BGFX_CONFIG_MAX_VERTEX_LAYOUTS> m_freeVertexLayout;
FreeHandle<VertexBufferHandle, BGFX_CONFIG_MAX_VERTEX_BUFFERS> m_freeVertexBuffer;
FreeHandle<ShaderHandle, BGFX_CONFIG_MAX_SHADERS> m_freeShader;
FreeHandle<ProgramHandle, BGFX_CONFIG_MAX_PROGRAMS> m_freeProgram;
FreeHandle<TextureHandle, BGFX_CONFIG_MAX_TEXTURES> m_freeTexture;
FreeHandle<FrameBufferHandle, BGFX_CONFIG_MAX_FRAME_BUFFERS> m_freeFrameBuffer;
FreeHandle<UniformHandle, BGFX_CONFIG_MAX_UNIFORMS> m_freeUniform;
TextVideoMem* m_textVideoMem;
Stats m_perfStats;
ViewStats* m_viewStats;
uint32_t m_numViewStats;
int64_t m_waitSubmit;
int64_t m_waitRender;
uint32_t m_frameNum;
bool m_capture;
bool m_flush;
bool m_needBindDedup;
uint64_t m_viewUsed[kViewUsedWords];
uint16_t m_viewUsedOffset[kViewUsedWords];
uint16_t m_numUsedViews;
uint32_t m_peakViews;
};
BX_ALIGN_DECL_CACHE_LINE(struct) EncoderImpl
{
EncoderImpl()
{
// Although it will be cleared by the discard(), the fact that the
// struct is padded to have a size equal to the cache line size,
// will leaves bytes uninitialized. This will influence the hashing
// as it reads those bytes too. To make this deterministic, we will
// clear all bytes (inclusively the padding) before we start.
bx::memSet(&m_bind, 0, sizeof(m_bind) );
m_key.reset();
m_discard = false;
m_draw.clear(BGFX_DISCARD_ALL);
m_compute.clear(BGFX_DISCARD_ALL);
m_bind.clear(BGFX_DISCARD_ALL);
m_bindMask = 0;
m_bindOccupied = 0;
m_matrixBlockFirst = 0;
m_matrixBlockNum = 0;
}
void begin(Frame* _frame, uint8_t _idx)
{
m_frame = _frame;
m_cpuTimeBegin = bx::getHPCounter();
m_uniformIdx = _idx;
m_uniformBegin = 0;
m_uniformEnd = 0;
UniformBuffer* uniformBuffer = m_frame->getUniformBuffer(m_uniformIdx);
uniformBuffer->reset();
m_numSubmitted = 0;
m_numDropped = 0;
m_bindHashMap.clear();
m_bindLlastIdx = 0;
m_bindEmptyIdx = UINT32_MAX;
m_bindDirty = true;
m_matrixBlockFirst = 0;
m_matrixBlockNum = 0;
bx::memSet(m_viewUsed, 0, sizeof(m_viewUsed) );
}
BX_FORCE_INLINE void markViewUsed(ViewId _id)
{
m_viewUsed[uint32_t(_id) >> 6] |= uint64_t(1) << (_id & 0x3f);
}
void end(bool _finalize)
{
if (_finalize)
{
UniformBuffer* uniformBuffer = m_frame->m_uniformBuffer[m_uniformIdx];
uniformBuffer->finish();
m_cpuTimeEnd = bx::getHPCounter();
}
if (BX_ENABLED(BGFX_CONFIG_DEBUG_OCCLUSION) )
{
m_occlusionQuerySet.clear();
}
if (BX_ENABLED(BGFX_CONFIG_DEBUG_UNIFORM) )
{
m_uniformSet.clear();
}
}
uint32_t bindStateIndex()
{
const uint32_t hash = hashBindings(m_bind.m_bind, m_bindOccupied);
BindHashMap::const_iterator it = m_bindHashMap.find(hash);
if (it != m_bindHashMap.end()
&& bindingsEqual(m_frame->m_renderBind[it->second].m_bind, m_bind.m_bind) )
{
return it->second;
}
const uint32_t idx = bx::atomicFetchAndAddsat<uint32_t>(&m_frame->m_numRenderBinds, 1, m_frame->m_maxDrawCalls);
m_frame->m_renderBind[idx] = m_bind;
if (it == m_bindHashMap.end() )
{
m_bindHashMap.insert(stl::make_pair(hash, idx) );
}
return idx;
}
uint32_t bindStateIndexCached()
{
if (m_bindDirty)
{
m_bindLlastIdx = bindStateIndex();
m_bindDirty = false;
}
else
{
BX_ASSERT(bindingsEqual(m_frame->m_renderBind[m_bindLlastIdx].m_bind, m_bind.m_bind)
, "Stale bind dirty flag: cached index %d does not match current bind."
, m_bindLlastIdx
);
}
return m_bindLlastIdx;
}
void clearBind(uint8_t _flags)
{
m_bind.clear(_flags, m_bindMask);
if (0 != (_flags & BGFX_DISCARD_BINDINGS) )
{
m_bindMask = 0;
m_bindOccupied = 0;
if (UINT32_MAX == m_bindEmptyIdx)
{
m_bindEmptyIdx = bindStateIndex();
}
m_bindLlastIdx = m_bindEmptyIdx;
m_bindDirty = false;
}
}
void setMarker(const bx::StringView& _name)
{
UniformBuffer::update(&m_frame->m_uniformBuffer[m_uniformIdx]);
UniformBuffer* uniformBuffer = m_frame->m_uniformBuffer[m_uniformIdx];
uniformBuffer->writeMarker(_name);
}
void setUniform(UniformType::Enum _type, UniformHandle _handle, const void* _value, uint16_t _num)
{
if (BX_ENABLED(BGFX_CONFIG_DEBUG_UNIFORM) )
{
BX_ASSERT(m_uniformSet.end() == m_uniformSet.find(_handle.idx)
, "Uniform %d (%s) was already set for this draw call."
, _handle.idx
, getName(_handle)
);
m_uniformSet.insert(_handle.idx);
const UniformRef& uniform = getUniformRef(_handle);
BX_ASSERT(UniformFreq::Draw == uniform.m_freq
, "Setting uniform for draw call, but uniform frequency is different (frequency: %d)!"
, uniform.m_freq
);
BX_UNUSED(uniform);
}
UniformBuffer::update(&m_frame->m_uniformBuffer[m_uniformIdx]);
UniformBuffer* uniformBuffer = m_frame->m_uniformBuffer[m_uniformIdx];
uniformBuffer->writeUniform(_type, _handle.idx, _value, _num);
}
void setUniformRef(UniformType::Enum _type, UniformHandle _handle, const void* _ptr, uint16_t _num)
{
if (BX_ENABLED(BGFX_CONFIG_DEBUG_UNIFORM) )
{
BX_ASSERT(m_uniformSet.end() == m_uniformSet.find(_handle.idx)
, "Uniform %d (%s) was already set for this draw call."
, _handle.idx
, getName(_handle)
);
m_uniformSet.insert(_handle.idx);
}
UniformBuffer::update(&m_frame->m_uniformBuffer[m_uniformIdx]);
UniformBuffer* uniformBuffer = m_frame->m_uniformBuffer[m_uniformIdx];
uniformBuffer->writeUniformRef(_type, _handle.idx, _ptr, _num);
}
void setState(uint64_t _state, uint32_t _rgba)
{
const uint8_t blend = ( (_state&BGFX_STATE_BLEND_MASK )>>BGFX_STATE_BLEND_SHIFT )&0xff;
m_key.m_hasAlphaRef = !!( ( (_state&BGFX_STATE_ALPHA_REF_MASK)>>BGFX_STATE_ALPHA_REF_SHIFT)&0xff);
// Transparency sort order table:
//
// +----------------------------------------- BGFX_STATE_BLEND_ZERO
// | +-------------------------------------- BGFX_STATE_BLEND_ONE
// | | +----------------------------------- BGFX_STATE_BLEND_SRC_COLOR
// | | | +-------------------------------- BGFX_STATE_BLEND_INV_SRC_COLOR
// | | | | +----------------------------- BGFX_STATE_BLEND_SRC_ALPHA
// | | | | | +-------------------------- BGFX_STATE_BLEND_INV_SRC_ALPHA
// | | | | | | +----------------------- BGFX_STATE_BLEND_DST_ALPHA
// | | | | | | | +-------------------- BGFX_STATE_BLEND_INV_DST_ALPHA
// | | | | | | | | +----------------- BGFX_STATE_BLEND_DST_COLOR
// | | | | | | | | | +-------------- BGFX_STATE_BLEND_INV_DST_COLOR
// | | | | | | | | | | +----------- BGFX_STATE_BLEND_SRC_ALPHA_SAT
// | | | | | | | | | | | +-------- BGFX_STATE_BLEND_FACTOR
// | | | | | | | | | | | | +----- BGFX_STATE_BLEND_INV_FACTOR
// | | | | | | | | | | | | |
// x | | | | | | | | | | | | | x x x x x
m_key.m_blend = "\x0\x1\x1\x2\x2\x1\x2\x1\x2\x1\x1\x1\x1\x1\x1\x1\x1\x1\x1"[( (blend)&0xf) + (!!blend)];
m_draw.m_stateFlags = _state;
m_draw.m_rgba = _rgba;
}
void setCondition(OcclusionQueryHandle _handle, bool _visible)
{
m_draw.m_occlusionQuery = _handle;
m_draw.m_submitFlags |= _visible ? BGFX_SUBMIT_INTERNAL_OCCLUSION_VISIBLE : 0;
}
void setStencil(uint32_t _fstencil, uint32_t _bstencil)
{
m_draw.m_stencil = packStencil(_fstencil, _bstencil);
}
void setSampleMask(uint32_t _mask)
{
m_draw.m_sampleMask = _mask;
}
uint16_t setScissor(uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height)
{
uint16_t scissor = bx::narrowCast<uint16_t>(m_frame->m_frameCache.m_rectCache.add(_x, _y, _width, _height) );
m_draw.m_scissor = scissor;
return scissor;
}
void setScissor(uint16_t _cache)
{
m_draw.m_scissor = _cache;
}
uint16_t setDepthControl(int32_t _constant, float _slopeScale, float _clamp, bool _depthClamp)
{
uint16_t idx = bx::narrowCast<uint16_t>(m_frame->m_frameCache.m_depthBiasCache.add(_constant, _slopeScale, _clamp, _depthClamp) );
m_draw.m_depthBias = idx;
return idx;
}
void setDepthControl(uint16_t _cache)
{
m_draw.m_depthBias = _cache;
}
uint32_t setTransform(const void* _mtx, uint16_t _num)
{
MatrixCache& matrixCache = m_frame->m_frameCache.m_matrixCache;
if (NULL != _mtx
&& 1 == _num)
{
if (0 == m_matrixBlockNum)
{
uint16_t num = kMatrixBlock;
m_matrixBlockFirst = matrixCache.reserve(&num);
m_matrixBlockNum = num;
}
if (0 != m_matrixBlockNum)
{
const uint32_t first = m_matrixBlockFirst++;
--m_matrixBlockNum;
bx::memCopy(&matrixCache.at(first), _mtx, sizeof(Matrix4) );
m_draw.m_startMatrix = first;
m_draw.m_numMatrices = 1;
return first;
}
}
m_draw.m_startMatrix = matrixCache.add(_mtx, &_num);
m_draw.m_numMatrices = bx::max<uint16_t>(_num, 1);
return m_draw.m_startMatrix;
}
uint32_t allocTransform(Transform* _transform, uint16_t _num)
{
uint32_t first = m_frame->m_frameCache.m_matrixCache.reserve(&_num);
_transform->data = m_frame->m_frameCache.m_matrixCache.toPtr(first);
_transform->num = _num;
return first;
}
void setTransform(uint32_t _cache, uint16_t _num)
{
const MatrixCache& matrixCache = m_frame->m_frameCache.m_matrixCache;
BX_ASSERT(_cache <= matrixCache.m_max, "Matrix cache out of bounds index %d (max: %d)"
, _cache
, matrixCache.m_max
);
const uint32_t first = bx::min(_cache, matrixCache.m_max);
const uint32_t last = bx::min(first + bx::max<uint32_t>(_num, 1), matrixCache.m_max+1);
m_draw.m_startMatrix = first;
m_draw.m_numMatrices = bx::narrowCast<uint16_t>(last - first);
}
void setIndexBuffer(IndexBufferHandle _handle, const IndexBuffer& _ib, uint32_t _firstIndex, uint32_t _numIndices)
{
m_draw.m_startIndex = _firstIndex;
m_draw.m_numIndices = _numIndices;
m_draw.m_indexBuffer = _handle;
m_draw.m_submitFlags |= 0 == (_ib.m_flags & BGFX_BUFFER_INDEX32) ? BGFX_SUBMIT_INTERNAL_NONE : BGFX_SUBMIT_INTERNAL_INDEX32;
}
void setIndexBuffer(const DynamicIndexBuffer& _dib, uint32_t _firstIndex, uint32_t _numIndices)
{
const uint32_t indexSize = 0 == (_dib.m_flags & BGFX_BUFFER_INDEX32) ? 2 : 4;
m_draw.m_startIndex = _dib.m_startIndex + _firstIndex;
m_draw.m_numIndices = bx::min(_numIndices, _dib.m_size/indexSize);
m_draw.m_indexBuffer = _dib.m_handle;
m_draw.m_submitFlags |= 0 == (_dib.m_flags & BGFX_BUFFER_INDEX32) ? BGFX_SUBMIT_INTERNAL_NONE : BGFX_SUBMIT_INTERNAL_INDEX32;
}
void setIndexBuffer(const TransientIndexBuffer* _tib, uint32_t _firstIndex, uint32_t _numIndices)
{
const uint32_t indexSize = _tib->isIndex16 ? 2 : 4;
const uint32_t numIndices = bx::min(_numIndices, _tib->size/indexSize);
m_draw.m_indexBuffer = _tib->handle;
m_draw.m_startIndex = _tib->startIndex + _firstIndex;
m_draw.m_numIndices = numIndices;
m_draw.m_submitFlags |= _tib->isIndex16 ? BGFX_SUBMIT_INTERNAL_NONE : BGFX_SUBMIT_INTERNAL_INDEX32;
m_discard = 0 == numIndices;
}
void setVertexBuffer(
uint8_t _stream
, VertexBufferHandle _handle
, uint32_t _startVertex
, uint32_t _numVertices
, VertexLayoutHandle _layoutHandle
)
{
BX_ASSERT(UINT32_MAX != m_draw.m_streamMask, "bgfx::setVertexCount was already called for this draw call.");
BX_ASSERT(_stream < BGFX_CONFIG_MAX_VERTEX_STREAMS, "Invalid stream %d (max %d).", _stream, BGFX_CONFIG_MAX_VERTEX_STREAMS);
if (m_draw.setStreamBit(_stream, _handle) )
{
Stream& stream = m_draw.m_stream[_stream];
stream.m_startVertex = _startVertex;
stream.m_handle = _handle;
stream.m_layoutHandle = _layoutHandle;
m_numVertices[_stream] = _numVertices;
}
}
void setVertexBuffer(
uint8_t _stream
, const DynamicVertexBuffer& _dvb
, uint32_t _startVertex
, uint32_t _numVertices
, VertexLayoutHandle _layoutHandle
)
{
BX_ASSERT(UINT32_MAX != m_draw.m_streamMask, "bgfx::setVertexCount was already called for this draw call.");
BX_ASSERT(_stream < BGFX_CONFIG_MAX_VERTEX_STREAMS, "Invalid stream %d (max %d).", _stream, BGFX_CONFIG_MAX_VERTEX_STREAMS);
if (m_draw.setStreamBit(_stream, _dvb.m_handle) )
{
Stream& stream = m_draw.m_stream[_stream];
stream.m_startVertex = _dvb.m_startVertex + _startVertex;
stream.m_handle = _dvb.m_handle;
stream.m_layoutHandle = isValid(_layoutHandle) ? _layoutHandle : _dvb.m_layoutHandle;
m_numVertices[_stream] = bx::min<uint32_t>(bx::max<int32_t>(0, _dvb.m_numVertices - _startVertex), _numVertices);
}
}
void setVertexBuffer(
uint8_t _stream
, const TransientVertexBuffer* _tvb
, uint32_t _startVertex
, uint32_t _numVertices
, VertexLayoutHandle _layoutHandle
)
{
BX_ASSERT(UINT32_MAX != m_draw.m_streamMask, "bgfx::setVertexCount was already called for this draw call.");
BX_ASSERT(_stream < BGFX_CONFIG_MAX_VERTEX_STREAMS, "Invalid stream %d (max %d).", _stream, BGFX_CONFIG_MAX_VERTEX_STREAMS);
if (m_draw.setStreamBit(_stream, _tvb->handle) )
{
Stream& stream = m_draw.m_stream[_stream];
stream.m_startVertex = _tvb->startVertex + _startVertex;
stream.m_handle = _tvb->handle;
stream.m_layoutHandle = isValid(_layoutHandle) ? _layoutHandle : _tvb->layoutHandle;
m_numVertices[_stream] = bx::min<uint32_t>(bx::max<int32_t>(0, _tvb->size/_tvb->stride - _startVertex), _numVertices);
}
}
void setVertexCount(uint32_t _numVertices)
{
BX_ASSERT(0 == m_draw.m_streamMask, "Vertex buffer already set.");
m_draw.m_streamMask = UINT32_MAX;
Stream& stream = m_draw.m_stream[0];
stream.m_startVertex = 0;
stream.m_handle.idx = kInvalidHandle;
stream.m_layoutHandle.idx = kInvalidHandle;
m_numVertices[0] = _numVertices;
}
void setInstanceDataBuffer(const InstanceDataBuffer* _idb, uint32_t _start, uint32_t _num)
{
const uint32_t start = bx::min(_start, _idb->num);
const uint32_t num = bx::min(_idb->num - start, _num);
m_draw.m_instanceDataOffset = _idb->offset + start*_idb->stride;
m_draw.m_instanceDataStride = _idb->stride;
m_draw.m_numInstances = num;
m_draw.m_instanceDataBuffer = _idb->handle;
}
void setInstanceDataBuffer(VertexBufferHandle _handle, uint32_t _startVertex, uint32_t _num, uint16_t _stride)
{
m_draw.m_instanceDataOffset = _startVertex * _stride;
m_draw.m_instanceDataStride = _stride;
m_draw.m_numInstances = _num;
m_draw.m_instanceDataBuffer = _handle;
}
void setInstanceCount(uint32_t _numInstances)
{
BX_ASSERT(!isValid(m_draw.m_instanceDataBuffer), "Instance buffer already set.");
m_draw.m_numInstances = _numInstances;
}
void setBind(uint8_t _stage, const Binding& _bind)
{
Binding& dst = m_bind.m_bind[_stage];
if (dst != _bind)
{
const uint32_t bit = UINT32_C(1)<<_stage;
dst = _bind;
m_bindDirty = true;
m_bindMask |= bit;
m_bindOccupied = _bind.isOccupied()
? m_bindOccupied | bit
: m_bindOccupied & ~bit
;
}
}
void setTexture(uint8_t _stage, UniformHandle _sampler, TextureHandle _handle, uint32_t _flags)
{
Binding bind;
bind.setTexture(
_handle
, 0 != (_flags&BGFX_SAMPLER_INTERNAL_DEFAULT)
? BGFX_SAMPLER_INTERNAL_DEFAULT
: _flags
);
setBind(_stage, bind);
if (isValid(_sampler) )
{
uint32_t stage = _stage;
setUniform(UniformType::Sampler, _sampler, &stage, 1);
}
}
void setTexture(uint8_t _stage, UniformHandle _sampler, TextureHandle _handle, uint16_t _firstLayer, uint16_t _numLayers, uint8_t _firstMip, uint8_t _numMips, uint32_t _flags, uint8_t _lodMin, uint8_t _lodMax)
{
Binding bind;
bind.setTexture(
_handle
, _firstLayer
, _numLayers
, _firstMip
, _numMips
, 0 != (_flags&BGFX_SAMPLER_INTERNAL_DEFAULT)
? BGFX_SAMPLER_INTERNAL_DEFAULT
: _flags
, _lodMin
, _lodMax
);
setBind(_stage, bind);
if (isValid(_sampler) )
{
uint32_t stage = _stage;
setUniform(UniformType::Sampler, _sampler, &stage, 1);
}
}
void setBuffer(uint8_t _stage, IndexBufferHandle _handle, Access::Enum _access, uint32_t _offset = 0, uint32_t _size = UINT32_MAX)
{
Binding bind;
bind.setIndexBuffer(_handle, _access, _offset, _size);
setBind(_stage, bind);
}
void setBuffer(uint8_t _stage, VertexBufferHandle _handle, Access::Enum _access, uint32_t _offset = 0, uint32_t _size = UINT32_MAX)
{
Binding bind;
bind.setBuffer(_handle, _access, _offset, _size);
setBind(_stage, bind);
}
void setImage(uint8_t _stage, TextureHandle _handle, uint8_t _mip, Access::Enum _access, TextureFormat::Enum _format)
{
Binding bind;
bind.setImage(_handle, _mip, _access, _format);
setBind(_stage, bind);
}
void setImage(uint8_t _stage, TextureHandle _handle, uint16_t _firstLayer, uint16_t _numLayers, uint8_t _mip, Access::Enum _access, TextureFormat::Enum _format)
{
Binding bind;
bind.setImage(_handle, _firstLayer, _numLayers, _mip, _access, _format);
setBind(_stage, bind);
}
void discard(uint8_t _flags)
{
if (BX_ENABLED(BGFX_CONFIG_DEBUG_UNIFORM) )
{
m_uniformSet.clear();
}
m_discard = false;
m_draw.clear(_flags);
m_compute.clear(_flags);
clearBind(_flags);
if (_flags & BGFX_DISCARD_STATE)
{
UniformBuffer* uniformBuffer = m_frame->m_uniformBuffer[m_uniformIdx];
m_uniformEnd = uniformBuffer->getPos();
m_uniformBegin = m_uniformEnd;
}
}
void submit(ViewId _id, ProgramHandle _program, OcclusionQueryHandle _occlusionQuery, uint32_t _depth, uint8_t _flags);
void submit(ViewId _id, ProgramHandle _program, IndirectBufferHandle _indirectHandle, uint32_t _start, uint32_t _num, uint32_t _depth, uint8_t _flags)
{
m_draw.m_startIndirect = _start;
m_draw.m_numIndirect = _num;
m_draw.m_indirectBuffer = _indirectHandle;
OcclusionQueryHandle handle = BGFX_INVALID_HANDLE;
submit(_id, _program, handle, _depth, _flags);
}
void submit(ViewId _id, ProgramHandle _program, IndirectBufferHandle _indirectHandle, uint32_t _start, IndexBufferHandle _numHandle, uint32_t _numIndex, uint32_t _numMax, uint32_t _depth, uint8_t _flags)
{
m_draw.m_numIndirectIndex = _numIndex;
m_draw.m_numIndirectBuffer = _numHandle;
submit(_id, _program, _indirectHandle, _start, _numMax, _depth, _flags);
}
void dispatch(ViewId _id, ProgramHandle _handle, uint32_t _ngx, uint32_t _ngy, uint32_t _ngz, uint8_t _flags);
void dispatch(ViewId _id, ProgramHandle _handle, IndirectBufferHandle _indirectHandle, uint32_t _start, uint32_t _num, uint8_t _flags)
{
m_compute.m_indirectBuffer = _indirectHandle;
m_compute.m_startIndirect = _start;
m_compute.m_numIndirect = _num;
dispatch(_id, _handle, 0, 0, 0, _flags);
}
void blit(ViewId _id, const BlitItem& _blit);
Frame* m_frame;
SortKey m_key;
RenderDraw m_draw;
RenderCompute m_compute;
RenderBind m_bind;
uint32_t m_numSubmitted;
uint32_t m_numDropped;
uint32_t m_uniformBegin;
uint32_t m_uniformEnd;
uint32_t m_numVertices[BGFX_CONFIG_MAX_VERTEX_STREAMS];
uint8_t m_uniformIdx;
bool m_discard;
typedef stl::unordered_set<uint16_t> HandleSet;
HandleSet m_uniformSet;
HandleSet m_occlusionQuerySet;
typedef stl::unordered_map<uint32_t, uint32_t> BindHashMap;
BindHashMap m_bindHashMap;
uint32_t m_bindLlastIdx;
uint32_t m_bindEmptyIdx;
uint32_t m_bindMask;
uint32_t m_bindOccupied;
uint32_t m_matrixBlockFirst;
uint16_t m_matrixBlockNum;
bool m_bindDirty;
int64_t m_cpuTimeBegin;
int64_t m_cpuTimeEnd;
uint64_t m_viewUsed[kViewUsedWords];
};
struct VertexLayoutRef
{
VertexLayoutRef()
{
}
void init()
{
bx::memSet(m_refCount, 0, sizeof(m_refCount) );
bx::memSet(m_stride, 0, sizeof(m_stride) );
}
template <uint16_t MaxHandlesT>
void shutdown(bx::HandleAlloc2T<MaxHandlesT>& _handleAlloc)
{
for (uint16_t idx = _handleAlloc.findFirst(); bx::kInvalidHandle != idx; idx = _handleAlloc.findNext(idx) )
{
m_refCount[idx] = 0;
m_vertexLayoutMap.removeByHandle(idx);
_handleAlloc.free(idx);
}
m_vertexLayoutMap.reset();
}
VertexLayoutHandle find(uint32_t _hash)
{
VertexLayoutHandle handle = { m_vertexLayoutMap.find(_hash) };
return handle;
}
void add(VertexLayoutHandle _layoutHandle, uint32_t _hash)
{
m_refCount[_layoutHandle.idx]++;
m_vertexLayoutMap.insert(_hash, _layoutHandle.idx);
}
void add(VertexBuffer& _vb, VertexLayoutHandle _layoutHandle, uint32_t _hash)
{
BX_ASSERT(!isValid(_vb.m_layoutHandle), "");
_vb.m_layoutHandle = _layoutHandle;
m_refCount[_layoutHandle.idx]++;
m_vertexLayoutMap.insert(_hash, _layoutHandle.idx);
}
void add(DynamicVertexBuffer& _dvb, VertexLayoutHandle _layoutHandle, uint32_t _hash)
{
BX_ASSERT(!isValid(_dvb.m_layoutHandle), "");
_dvb.m_layoutHandle = _layoutHandle;
m_refCount[_layoutHandle.idx]++;
m_vertexLayoutMap.insert(_hash, _layoutHandle.idx);
}
VertexLayoutHandle release(VertexLayoutHandle _layoutHandle)
{
if (isValid(_layoutHandle) )
{
m_refCount[_layoutHandle.idx]--;
if (0 == m_refCount[_layoutHandle.idx])
{
m_vertexLayoutMap.removeByHandle(_layoutHandle.idx);
return _layoutHandle;
}
}
return BGFX_INVALID_HANDLE;
}
VertexLayoutHandle release(VertexBuffer& _vb)
{
VertexLayoutHandle layoutHandle = release(_vb.m_layoutHandle);
_vb.m_layoutHandle = BGFX_INVALID_HANDLE;
return layoutHandle;
}
VertexLayoutHandle release(DynamicVertexBuffer& _dvb)
{
VertexLayoutHandle layoutHandle = release(_dvb.m_layoutHandle);
_dvb.m_layoutHandle = BGFX_INVALID_HANDLE;
return layoutHandle;
}
typedef bx::HandleHashMapT<BGFX_CONFIG_MAX_VERTEX_LAYOUTS*2> VertexLayoutMap;
VertexLayoutMap m_vertexLayoutMap;
uint16_t m_refCount[BGFX_CONFIG_MAX_VERTEX_LAYOUTS];
uint16_t m_stride[BGFX_CONFIG_MAX_VERTEX_LAYOUTS];
};
// First-fit non-local allocator.
//
// The free list is kept sorted by address at all times, which:
// - Enables O(1) adjacent-block coalescing on free.
// - Provides cache-friendly iteration (contiguous vector storage).
// - Uses binary search for sorted insertion, replacing the O(n) push_front.
//
class NonLocalAllocator
{
public:
static const uint64_t kInvalidBlock = UINT64_MAX;
NonLocalAllocator()
: m_totalUsed(0)
, m_totalAvailable(0)
{
}
~NonLocalAllocator()
{
}
void reset()
{
m_free.clear();
m_used.clear();
m_slab.clear();
m_totalUsed = 0;
}
void add(uint64_t _ptr, uint32_t _size)
{
m_slab.insert(stl::make_pair(_ptr, _size) );
insertFreeBlock(_ptr, _size);
m_totalAvailable += _size;
}
uint64_t remove()
{
BX_ASSERT(0 == m_used.size(), "");
if (0 < m_free.size() )
{
Free freeBlock = m_free.front();
m_free.erase(m_free.begin() );
m_slab.erase(m_slab.find(freeBlock.m_ptr));
m_totalAvailable -= freeBlock.m_size;
return freeBlock.m_ptr;
}
return 0;
}
/// Returns the base address of a fully-free buffer region, or 0 if
/// none found. Call in a loop after free() to reclaim individual
/// GPU buffers whose sub-allocations have all been released.
uint64_t removeOrphaned()
{
for (FreeList::iterator it = m_free.begin(), itEnd = m_free.end(); it != itEnd; ++it)
{
SlabList::iterator slabIt = m_slab.find(it->m_ptr);
if (slabIt != m_slab.end()
&& slabIt->second == it->m_size)
{
m_totalAvailable -= it->m_size;
uint64_t ptr = it->m_ptr;
m_free.erase(it);
m_slab.erase(slabIt);
return ptr;
}
}
return 0;
}
uint64_t alloc(uint32_t _size)
{
_size = bx::max(_size, 16u);
for (FreeList::iterator it = m_free.begin(), itEnd = m_free.end(); it != itEnd; ++it)
{
if (it->m_size >= _size)
{
uint64_t ptr = it->m_ptr;
m_used.insert(stl::make_pair(ptr, _size) );
m_totalUsed += _size;
if (it->m_size != _size)
{
it->m_size -= _size;
it->m_ptr += _size;
}
else
{
m_free.erase(it);
}
return ptr;
}
}
// there is no block large enough.
return kInvalidBlock;
}
void free(uint64_t _block)
{
UsedList::iterator it = m_used.find(_block);
if (it != m_used.end() )
{
const uint64_t ptr = it->first;
const uint32_t size = it->second;
m_totalUsed -= size;
m_used.erase(it);
// Insert into sorted free list and coalesce with adjacent blocks.
insertFreeBlock(ptr, size);
}
}
uint32_t getTotalUsed() const
{
return m_totalUsed;
}
uint32_t getTotalAvailable() const
{
return m_totalAvailable;
}
private:
struct Free
{
Free(uint64_t _ptr, uint32_t _size)
: m_ptr(_ptr)
, m_size(_size)
{
}
bool operator<(const Free& rhs) const
{
return m_ptr < rhs.m_ptr;
}
bool operator>(const Free& rhs) const
{
return m_ptr > rhs.m_ptr;
}
uint64_t m_ptr;
uint32_t m_size;
};
// Insert a free block at its sorted position and coalesce with
// adjacent neighbors. Uses bx::upperBound to find the insertion
// point in O(log n), then checks the immediate neighbors for
// merge opportunities.
void insertFreeBlock(uint64_t _ptr, uint32_t _size)
{
// Use bx::upperBound to find the insertion point (first element with m_ptr > _ptr).
const Free key(_ptr, 0);
const uint32_t idx = 0 < m_free.size()
? bx::upperBound(key, m_free.data(), uint32_t(m_free.size() ) )
: 0
;
// Check if we can merge with the previous block.
const bool mergePrev = idx > 0
&& (m_free[idx - 1].m_ptr + m_free[idx - 1].m_size) == _ptr
;
// Check if we can merge with the next block.
const bool mergeNext = idx < uint32_t(m_free.size() )
&& (_ptr + _size) == m_free[idx].m_ptr
;
if (mergePrev && mergeNext)
{
// Merge all three: extend previous to cover current + next.
m_free[idx - 1].m_size += _size + m_free[idx].m_size;
m_free.erase(m_free.begin() + idx);
}
else if (mergePrev)
{
// Extend previous block.
m_free[idx - 1].m_size += _size;
}
else if (mergeNext)
{
// Extend next block backward.
m_free[idx].m_ptr = _ptr;
m_free[idx].m_size += _size;
}
else
{
// No merge possible — insert new block at sorted position.
m_free.insert(m_free.begin() + idx, Free(_ptr, _size) );
}
}
typedef stl::vector<Free> FreeList;
FreeList m_free;
typedef stl::unordered_map<uint64_t, uint32_t> UsedList;
UsedList m_used;
typedef stl::unordered_map<uint64_t, uint32_t> SlabList;
SlabList m_slab;
uint32_t m_totalUsed;
uint32_t m_totalAvailable;
};
struct UniformCache
{
UniformCache()
{
const uint32_t size = 1<<20;
m_data = (uint8_t*)bx::alloc(g_allocator, size);
m_uniformStoreAlloc.add(0, size);
}
~UniformCache()
{
BX_ASSERT(true
&& 0 == m_uniformKeyHashMap.size()
&& 0 == m_uniformEntryMap.size()
&& 0 == m_uniformStoreAlloc.getTotalUsed()
, "UniformCache leak (keys %d, entries %d, %d bytes)!"
, m_uniformKeyHashMap.size()
, m_uniformEntryMap.size()
, m_uniformStoreAlloc.getTotalUsed()
);
bx::free(g_allocator, m_data);
m_uniformKeyHashMap.clear();
m_uniformEntryMap.clear();
}
void setViewUniform(ViewId _id, UniformHandle _handle, const void* _value, uint16_t _num)
{
const UniformRef& uniform = getUniformRef(_handle);
const UniformFreq::Enum freq = UINT16_MAX == _id
? UniformFreq::Frame
: UniformFreq::View
;
BX_ASSERT(0 < uniform.m_refCount
, "Uniform reference count it 0 (handle %3d)!"
, _handle.idx
);
BX_ASSERT(uniform.m_freq == freq
, "Setting uniform per view, but uniform is created with different bgfx::UniformFreq::Enum!"
);
BX_ASSERT(_num == UINT16_MAX || uniform.m_num >= _num
, "Truncated uniform update. %d (max: %d)"
, _num, uniform.m_num
);
BX_UNUSED(freq);
UniformCacheKey key =
{
.m_offset = 0,
.m_handle = _handle.idx,
.m_size = 0,
.m_view = _id,
};
static constexpr UniformCacheKey::KeyT kViewHandleMask = UniformCacheKey::kViewMask|UniformCacheKey::kHandleMask;
static_assert( ( (kViewHandleMask>>32)<<32) == kViewHandleMask, "View + handle must be in top 32 bits of 64-bit key.");
const uint32_t uniformKey = uint32_t(key.encode() >> 32);
setUniform(uniformKey, uniform.m_type, _value, _num);
}
void setUniform(uint32_t _uniformKey, UniformType::Enum _type, const void* _value, uint16_t _num)
{
const uint32_t typeSize = g_uniformTypeSize[_type];
const uint32_t dataSize = _num * typeSize;
const uint32_t allocSize = bx::alignUp(dataSize, 16);
BX_ASSERT(allocSize <= UINT16_MAX-15
, "Uniform is too large for the uniform cache (%d bytes, max %d)!"
, allocSize
, UINT16_MAX-15
);
bx::HashMurmur3 murmur;
murmur.begin();
murmur.add(_type);
murmur.add(_num);
murmur.add(_value, dataSize);
const uint32_t hash = murmur.end();
UniformKeyHashMap::iterator itKey = m_uniformKeyHashMap.find(_uniformKey);
if (itKey != m_uniformKeyHashMap.end() )
{
if (itKey->second == hash)
{
return;
}
UniformEntryMap::iterator itOldEntry = m_uniformEntryMap.find(itKey->second);
if (itOldEntry != m_uniformEntryMap.end())
{
if (release(itOldEntry->second) )
{
m_uniformEntryMap.erase(itOldEntry);
}
}
itKey->second = hash;
UniformEntryMap::iterator itEntry = m_uniformEntryMap.find(hash);
if (itEntry != m_uniformEntryMap.end())
{
++itEntry->second.refCount;
return;
}
}
else
{
m_uniformKeyHashMap.insert(stl::make_pair(_uniformKey, hash) );
}
UniformEntryMap::iterator itEntry = m_uniformEntryMap.find(hash);
if (itEntry != m_uniformEntryMap.end())
{
++itEntry->second.refCount;
}
else
{
const uint64_t offset = m_uniformStoreAlloc.alloc(allocSize);
if (NonLocalAllocator::kInvalidBlock == offset)
{
BX_ASSERT(false, "UniformCache: Failed to allocate data (%d bytes)!", allocSize);
m_uniformKeyHashMap.erase(m_uniformKeyHashMap.find(_uniformKey) );
return;
}
m_uniformEntryMap.insert(stl::make_pair(hash, UniformCacheEntry
{
.offset = bx::narrowCast<uint32_t>(offset),
.size = bx::narrowCast<uint16_t>(allocSize),
.refCount = 1
}) );
bx::memCopy(&m_data[offset], _value, dataSize);
bx::memSet(&m_data[offset + dataSize], 0, allocSize - dataSize);
}
}
void frame(UniformCacheFrame& _outUniformCacheFrame)
{
_outUniformCacheFrame.resize(
uint32_t(m_uniformKeyHashMap.size() )
, m_uniformStoreAlloc.getTotalUsed()
);
using OffsetRemap = stl::unordered_map<uint32_t, uint32_t>;
OffsetRemap offsetRemap;
uint32_t linearOffset = 0;
uint32_t num = 0;
for (UniformKeyHashMap::const_iterator itKey = m_uniformKeyHashMap.begin(), itEnd = m_uniformKeyHashMap.end(); itKey != itEnd; ++itKey)
{
UniformEntryMap::iterator itEntry = m_uniformEntryMap.find(itKey->second);
BX_ASSERT(itEntry != m_uniformEntryMap.end()
, "Couldn't find uniform cache entry for key 0x%d, hash 0x%x!"
, itKey->first
, itKey->second
);
const uint32_t offset = itEntry->second.offset;
const uint16_t size = itEntry->second.size;
UniformCacheKey key;
key.decode(uint64_t(itKey->first)<<32);
key.m_size = size;
OffsetRemap::const_iterator itOffset = offsetRemap.find(offset);
if (itOffset != offsetRemap.end())
{
key.m_offset = itOffset->second;
}
else
{
key.m_offset = linearOffset;
offsetRemap.insert(stl::make_pair(offset, linearOffset) );
bx::memCopy(&_outUniformCacheFrame.m_data[linearOffset], &m_data[offset], size);
linearOffset += size;
}
_outUniformCacheFrame.m_keys[num++] = key.encode();
}
_outUniformCacheFrame.m_numItems = num;
_outUniformCacheFrame.m_keys[num] = 0;
}
void invalidate(ViewId _viewId)
{
for (UniformKeyHashMap::iterator itKey = m_uniformKeyHashMap.begin(), itEnd = m_uniformKeyHashMap.end(); itKey != itEnd;)
{
UniformCacheKey key;
key.decode(uint64_t(itKey->first) << 32);
if (key.m_view == _viewId)
{
release(itKey->second);
UniformKeyHashMap::iterator itErase = itKey;
++itKey;
m_uniformKeyHashMap.erase(itErase);
}
else
{
++itKey;
}
}
}
void invalidate(UniformHandle _handle)
{
for (UniformKeyHashMap::iterator itKey = m_uniformKeyHashMap.begin(), itEnd = m_uniformKeyHashMap.end(); itKey != itEnd;)
{
UniformCacheKey key;
key.decode(uint64_t(itKey->first) << 32);
if (key.m_handle == _handle.idx)
{
release(itKey->second);
UniformKeyHashMap::iterator itErase = itKey;
++itKey;
m_uniformKeyHashMap.erase(itErase);
}
else
{
++itKey;
}
}
}
bool release(UniformCacheEntry& _entry)
{
--_entry.refCount;
if (0 == _entry.refCount)
{
const uint64_t offset = _entry.offset;
m_uniformStoreAlloc.free(offset);
return true;
}
return false;
}
void release(uint32_t _hash)
{
UniformEntryMap::iterator itEntry = m_uniformEntryMap.find(_hash);
if (itEntry != m_uniformEntryMap.end())
{
if (release(itEntry->second) )
{
m_uniformEntryMap.erase(itEntry);
}
}
}
using UniformKeyHashMap = stl::unordered_map<uint32_t, uint32_t>;
using UniformEntryMap = stl::unordered_map<uint32_t, UniformCacheEntry>;
UniformKeyHashMap m_uniformKeyHashMap;
UniformEntryMap m_uniformEntryMap;
NonLocalAllocator m_uniformStoreAlloc;
uint8_t* m_data;
};
struct BX_NO_VTABLE RendererContextI
{
RendererContextI()
{
bx::memSet(m_uniforms, 0, sizeof(m_uniforms) );
}
virtual ~RendererContextI() = 0;
virtual RendererType::Enum getRendererType() const = 0;
virtual const char* getRendererName() const = 0;
virtual bool isDeviceRemoved() = 0;
virtual void flip() = 0;
virtual void createIndexBuffer(IndexBufferHandle _handle, const Memory* _mem, uint16_t _flags) = 0;
virtual void destroyIndexBuffer(IndexBufferHandle _handle) = 0;
virtual void createVertexLayout(VertexLayoutHandle _handle, const VertexLayout& _layout) = 0;
virtual void destroyVertexLayout(VertexLayoutHandle _handle) = 0;
virtual void createVertexBuffer(VertexBufferHandle _handle, const Memory* _mem, VertexLayoutHandle _layoutHandle, uint16_t _flags) = 0;
virtual void destroyVertexBuffer(VertexBufferHandle _handle) = 0;
virtual void createDynamicIndexBuffer(IndexBufferHandle _handle, uint32_t _size, uint16_t _flags) = 0;
virtual void updateDynamicIndexBuffer(IndexBufferHandle _handle, uint32_t _offset, uint32_t _size, const Memory* _mem) = 0;
virtual void destroyDynamicIndexBuffer(IndexBufferHandle _handle) = 0;
virtual void createDynamicVertexBuffer(VertexBufferHandle _handle, uint32_t _size, uint16_t _flags) = 0;
virtual void updateDynamicVertexBuffer(VertexBufferHandle _handle, uint32_t _offset, uint32_t _size, const Memory* _mem) = 0;
virtual void destroyDynamicVertexBuffer(VertexBufferHandle _handle) = 0;
virtual void createShader(ShaderHandle _handle, const Memory* _mem) = 0;
virtual void destroyShader(ShaderHandle _handle) = 0;
virtual void createProgram(ProgramHandle _handle, ShaderHandle _vsh, ShaderHandle _fsh) = 0;
virtual void destroyProgram(ProgramHandle _handle) = 0;
virtual void* createTexture(TextureHandle _handle, const Memory* _mem, uint64_t _flags, uint8_t _skip, uint64_t _external) = 0;
virtual void updateTexture(TextureHandle _handle, uint8_t _side, uint8_t _mip, const Rect& _rect, uint16_t _z, uint16_t _depth, uint16_t _pitch, const Memory* _mem) = 0;
virtual void clearTexture(TextureHandle _handle, uint8_t _mip, uint8_t _numMips, uint16_t _layer, uint16_t _numLayers) = 0;
virtual void readTexture(TextureHandle _handle, void* _data, uint16_t _layer, uint8_t _mip) = 0;
virtual void readBuffer(Handle _handle, void* _data, uint32_t _offset, uint32_t _size) = 0;
virtual void resizeTexture(TextureHandle _handle, uint16_t _width, uint16_t _height, uint8_t _numMips, uint16_t _numLayers) = 0;
virtual uintptr_t getInternal(TextureHandle _handle) = 0;
virtual void destroyTexture(TextureHandle _handle) = 0;
virtual void createFrameBuffer(FrameBufferHandle _handle, uint8_t _num, const Attachment* _attachment) = 0;
virtual void createFrameBuffer(FrameBufferHandle _handle, const SwapChain& _desc) = 0;
virtual void resizeFrameBuffer(FrameBufferHandle _handle, const SwapChain& _desc)
{
destroyFrameBuffer(_handle);
createFrameBuffer(_handle, _desc);
}
virtual void destroyFrameBuffer(FrameBufferHandle _handle) = 0;
virtual void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) = 0;
virtual void invalidateOcclusionQuery(OcclusionQueryHandle _handle) = 0;
virtual void setMarker(const char* _name, uint16_t _len) = 0;
virtual void setName(Handle _handle, const char* _name, uint16_t _len) = 0;
virtual void submit(Frame* _render, const ClearQuad& _clearQuad, const MipGen& _mipGen, TextVideoMemBlitter& _textVideoMemBlitter) = 0;
virtual void dbgTextRenderBegin(TextVideoMemBlitter& _blitter, FrameBufferHandle _handle) = 0;
virtual void dbgTextRender(TextVideoMemBlitter& _blitter, uint32_t _numIndices) = 0;
virtual void dbgTextRenderEnd(TextVideoMemBlitter& _blitter) = 0;
void createUniform(UniformHandle _handle, UniformType::Enum _type, uint16_t _num, const char* _name)
{
if (NULL != m_uniforms[_handle.idx])
{
bx::free(g_allocator, m_uniforms[_handle.idx]);
}
const uint32_t size = bx::alignUp(g_uniformTypeSize[_type]*_num, 16);
void* data = bx::alloc(g_allocator, size);
bx::memSet(data, 0, size);
m_uniforms[_handle.idx] = data;
m_uniformReg.add(_handle, _name);
}
void destroyUniform(UniformHandle _handle)
{
bx::free(g_allocator, m_uniforms[_handle.idx]);
m_uniforms[_handle.idx] = NULL;
m_uniformReg.remove(_handle);
}
void updateUniform(uint16_t _loc, const void* _data, uint32_t _size)
{
bx::memCopy(m_uniforms[_loc], _data, _size);
}
UniformRegistry m_uniformReg;
void* m_uniforms[BGFX_CONFIG_MAX_UNIFORMS];
};
inline RendererContextI::~RendererContextI()
{
for (uint32_t ii = 0; ii < BX_COUNTOF(m_uniforms); ++ii)
{
bx::free(g_allocator, m_uniforms[ii]);
m_uniforms[ii] = NULL;
}
}
void rendererUpdateUniforms(RendererContextI* _renderCtx, UniformBuffer* _uniformBuffer, uint32_t _begin, uint32_t _end);
#if BGFX_CONFIG_DEBUG
# define BGFX_API_FUNC(_func) BX_NO_INLINE _func
#else
# define BGFX_API_FUNC(_func) _func
#endif // BGFX_CONFIG_DEBUG
struct Context
{
static constexpr uint32_t kAlignment = 64;
Context()
: m_render(&m_frame[0])
, m_submit(&m_frame[BGFX_CONFIG_MULTITHREADED ? 1 : 0])
, m_tempKeys(NULL)
, m_tempValues(NULL)
, m_tempCapacity(0)
, m_numDrawCallsPeak(0)
, m_numFreeOcclusionQueryHandles(0)
, m_numNewOcclusionQueryHandles(0)
, m_colorPaletteDirty(2)
, m_frames(0)
, m_debug(BGFX_DEBUG_NONE)
, m_rtMemoryUsed(0)
, m_textureMemoryUsed(0)
, m_renderCtx(NULL)
, m_headless(false)
, m_rendererInitialized(false)
, m_exit(false)
, m_flipAfterRender(false)
, m_singleThreaded(false)
, m_flushPrevFrame(false)
{
}
~Context()
{
bx::free(g_allocator, m_tempKeys);
bx::free(g_allocator, m_tempValues);
}
void reserveTemp(uint32_t _num)
{
if (m_tempCapacity < _num)
{
bx::free(g_allocator, m_tempKeys);
bx::free(g_allocator, m_tempValues);
m_tempCapacity = _num;
m_tempKeys = (uint64_t* )bx::alloc(g_allocator, sizeof(uint64_t )*_num);
m_tempValues = (RenderItemCount*)bx::alloc(g_allocator, sizeof(RenderItemCount)*_num);
}
}
#if BX_CONFIG_SUPPORTS_THREADING
static int32_t renderThread(bx::Thread* /*_self*/, void* /*_userData*/)
{
BX_TRACE("render thread start");
BGFX_PROFILER_SET_CURRENT_THREAD_NAME("bgfx - Render Thread");
while (RenderFrame::Exiting != bgfx::renderFrame() ) {};
BX_TRACE("render thread exit");
return bx::kExitSuccess;
}
#endif // BX_CONFIG_SUPPORTS_THREADING
// game thread
bool init(const Init& _init);
void shutdown();
CommandBuffer& getCommandBuffer(CommandBuffer::Enum _cmd)
{
CommandBuffer& cmdbuf = _cmd < CommandBuffer::End ? m_submit->m_cmdPre : m_submit->m_cmdPost;
uint8_t cmd = (uint8_t)_cmd;
cmdbuf.write(cmd);
return cmdbuf;
}
BGFX_API_FUNC(void reset(uint32_t _flags, const SwapChain* _swapChain) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BX_ASSERT(NULL == _swapChain || !m_headless
, "bgfx::init created no main swap chain, so `_swapChain` must be NULL."
);
BX_WARN(0 == (_flags & kSwapChainFlagMask)
, "Per-surface flags passed to `reset` are ignored. They belong on `SwapChain::flags`."
);
const uint32_t resetFlags = _flags & ~kSwapChainFlagMask;
SwapChain swapChain = m_init.swapChain;
if (NULL != _swapChain
&& !m_headless)
{
checkSwapChainDepth(*_swapChain);
swapChain = *_swapChain;
if (NULL == swapChain.nwh)
{
swapChain.nwh = m_init.swapChain.nwh;
}
if (NULL == swapChain.ndt)
{
swapChain.ndt = m_init.swapChain.ndt;
}
if (TextureFormat::Count == swapChain.formatColor)
{
swapChain.formatColor = m_init.swapChain.formatColor;
}
if (TextureFormat::Count == swapChain.formatDepthStencil)
{
swapChain.formatDepthStencil = m_init.swapChain.formatDepthStencil;
}
if (0 == swapChain.numBackBuffers)
{
swapChain.numBackBuffers = m_init.swapChain.numBackBuffers;
}
if (0 == swapChain.maxFrameLatency)
{
swapChain.maxFrameLatency = m_init.swapChain.maxFrameLatency;
}
BX_ASSERT(0 != (g_caps.formats[swapChain.formatColor] & BGFX_CAPS_FORMAT_TEXTURE_BACKBUFFER)
, "Format %s can't be used for back buffer!"
, getName(swapChain.formatColor)
);
BX_WARN(g_caps.limits.maxTextureSize >= swapChain.width
&& g_caps.limits.maxTextureSize >= swapChain.height
, "Frame buffer resolution width or height can't be larger than limits.maxTextureSize %d (width %d, height %d)."
, g_caps.limits.maxTextureSize
, swapChain.width
, swapChain.height
);
swapChain.flags = checkSwapChainFlags(swapChain.flags & kSwapChainFlagMask);
swapChain.width = bx::clamp(swapChain.width, 1u, g_caps.limits.maxTextureSize);
swapChain.height = bx::clamp(swapChain.height, 1u, g_caps.limits.maxTextureSize);
}
if (m_init.reset == resetFlags
&& 0 == bx::memCmp(&swapChain, &m_init.swapChain, sizeof(SwapChain) ) )
{
// Nothing changed, ignore request.
return;
}
m_init.swapChain = swapChain;
m_init.reset = resetFlags;
dump(m_init.swapChain, m_init.reset);
m_flipAfterRender = !!(resetFlags & BGFX_RESET_FLIP_AFTER_RENDER);
for (uint32_t ii = 0; ii < BGFX_CONFIG_MAX_VIEWS; ++ii)
{
View* view = m_view.find(ii);
if (NULL != view)
{
view->setFrameBuffer(BGFX_INVALID_HANDLE);
}
}
for (uint16_t textureIdx = m_textureHandle.findFirst(); bx::kInvalidHandle != textureIdx; textureIdx = m_textureHandle.findNext(textureIdx) )
{
const TextureRef& ref = m_textureRef[textureIdx];
if (BackbufferRatio::Count != ref.m_bbRatio)
{
TextureHandle handle = { textureIdx };
resizeTexture(handle
, uint16_t(m_init.swapChain.width)
, uint16_t(m_init.swapChain.height)
, ref.m_numMips
, ref.m_numLayers
);
m_init.reset |= BGFX_RESET_INTERNAL_FORCE;
}
}
}
BGFX_API_FUNC(void setDebug(uint32_t _debug, FrameBufferHandle _handle, uint8_t _scale) )
{
BGFX_CHECK_HANDLE_INVALID_OK("setDebug", m_frameBufferHandle, _handle);
m_debug = _debug;
m_debugFrameBuffer = _handle;
m_debugTextScale = bx::clamp<uint8_t>(_scale, 1, BGFX_CONFIG_DEBUG_TEXT_MAX_SCALE);
}
void getDebugFrameBufferSize(uint16_t& _width, uint16_t& _height) const
{
if (isValid(m_debugFrameBuffer) )
{
const FrameBufferRef& fbr = m_frameBufferRef[m_debugFrameBuffer.idx];
_width = fbr.m_width;
_height = fbr.m_height;
}
else
{
_width = uint16_t(m_init.swapChain.width);
_height = uint16_t(m_init.swapChain.height);
}
}
BGFX_API_FUNC(void dbgTextClear(uint8_t _attr, bool _small) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
if (BX_ENABLED(BGFX_CONFIG_DEBUG_TEXT) )
{
uint16_t width;
uint16_t height;
getDebugFrameBufferSize(width, height);
m_submit->m_textVideoMem->resize(
_small
, width / m_debugTextScale
, height / m_debugTextScale
);
m_submit->m_textVideoMem->clear(_attr);
}
}
BGFX_API_FUNC(void dbgTextPrintfVargs(uint16_t _x, uint16_t _y, uint8_t _attr, const char* _format, va_list _argList) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
if (BX_ENABLED(BGFX_CONFIG_DEBUG_TEXT) )
{
m_submit->m_textVideoMem->printfVargs(_x, _y, _attr, _format, _argList);
}
}
BGFX_API_FUNC(void dbgTextImage(uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height, const void* _data, uint16_t _pitch) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
if (BX_ENABLED(BGFX_CONFIG_DEBUG_TEXT) )
{
m_submit->m_textVideoMem->image(_x, _y, _width, _height, _data, _pitch);
}
}
BGFX_API_FUNC(const Stats* getPerfStats() )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
Stats& stats = m_submit->m_perfStats;
const SwapChain& resolution = m_submit->m_mainSwapChain;
stats.width = uint16_t(resolution.width);
stats.height = uint16_t(resolution.height);
stats.textWidth = 0;
stats.textHeight = 0;
if (BX_ENABLED(BGFX_CONFIG_DEBUG_TEXT) )
{
const TextVideoMem* tvm = m_submit->m_textVideoMem;
stats.textWidth = tvm->m_width;
stats.textHeight = tvm->m_height;
}
stats.encoderStats = m_encoderStats;
stats.numDynamicIndexBuffers = m_dynamicIndexBufferHandle.getNumHandles();
stats.numDynamicVertexBuffers = m_dynamicVertexBufferHandle.getNumHandles();
stats.numFrameBuffers = m_frameBufferHandle.getNumHandles();
stats.numIndexBuffers = m_indexBufferHandle.getNumHandles();
stats.numOcclusionQueries = m_occlusionQueryHandle.getNumHandles();
stats.numPrograms = m_programHandle.getNumHandles();
stats.numShaders = m_shaderHandle.getNumHandles();
stats.numTextures = m_textureHandle.getNumHandles();
stats.numUniforms = m_uniformHandle.getNumHandles();
stats.numVertexBuffers = m_vertexBufferHandle.getNumHandles();
stats.numVertexLayouts = m_layoutHandle.getNumHandles();
stats.textureMemoryUsed = m_textureMemoryUsed;
stats.rtMemoryUsed = m_rtMemoryUsed;
stats.numDrawCallsPeak = m_numDrawCallsPeak;
return &stats;
}
BGFX_API_FUNC(IndexBufferHandle createIndexBuffer(const Memory* _mem, uint16_t _flags) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
IndexBufferHandle handle = { m_indexBufferHandle.alloc() };
BX_WARN(isValid(handle), "Failed to allocate index buffer handle.");
if (isValid(handle) )
{
IndexBuffer& ib = m_indexBuffers.alloc(handle.idx);
ib.m_size = _mem->size;
ib.m_flags = _flags;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateIndexBuffer);
cmdbuf.write(handle);
cmdbuf.write(_mem);
cmdbuf.write(_flags);
setDebugNameForHandle(handle);
}
else
{
release(_mem);
}
return handle;
}
BGFX_API_FUNC(void setName(IndexBufferHandle _handle, const bx::StringView& _name) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("setName", m_indexBufferHandle, _handle);
IndexBuffer& ref = m_indexBuffers[_handle.idx];
ref.m_name.set(_name);
setNameForHandle(_handle, _name);
}
BGFX_API_FUNC(void destroyIndexBuffer(IndexBufferHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyIndexBuffer", m_indexBufferHandle, _handle);
bool ok = m_submit->free(_handle); BX_UNUSED(ok);
BX_ASSERT(ok, "Index buffer handle %d is already destroyed!", _handle.idx);
IndexBuffer& ref = m_indexBuffers[_handle.idx];
ref.m_name.clear();
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyIndexBuffer);
cmdbuf.write(_handle);
}
VertexLayoutHandle findOrCreateVertexLayout(const VertexLayout& _layout, bool _refCountOnCreation = false)
{
VertexLayoutHandle layoutHandle = m_vertexLayoutRef.find(_layout.m_hash);
if (isValid(layoutHandle) )
{
return layoutHandle;
}
layoutHandle = { m_layoutHandle.alloc() };
if (!isValid(layoutHandle) )
{
BX_TRACE("WARNING: Failed to allocate vertex layout handle (BGFX_CONFIG_MAX_VERTEX_LAYOUTS, max: %d).", BGFX_CONFIG_MAX_VERTEX_LAYOUTS);
return BGFX_INVALID_HANDLE;
}
m_vertexLayoutRef.m_stride[layoutHandle.idx] = _layout.m_stride;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateVertexLayout);
cmdbuf.write(layoutHandle);
cmdbuf.write(_layout);
if (_refCountOnCreation)
{
m_vertexLayoutRef.add(layoutHandle, _layout.m_hash);
}
return layoutHandle;
}
BGFX_API_FUNC(VertexLayoutHandle createVertexLayout(const VertexLayout& _layout) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
VertexLayoutHandle handle = findOrCreateVertexLayout(_layout);
if (!isValid(handle) )
{
return BGFX_INVALID_HANDLE;
}
m_vertexLayoutRef.add(handle, _layout.m_hash);
return handle;
}
BGFX_API_FUNC(void destroyVertexLayout(VertexLayoutHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
if (isValid(m_vertexLayoutRef.release(_handle) ) )
{
m_submit->free(_handle);
}
}
BGFX_API_FUNC(VertexBufferHandle createVertexBuffer(const Memory* _mem, const VertexLayout& _layout, uint16_t _flags) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
VertexBufferHandle handle = { m_vertexBufferHandle.alloc() };
if (isValid(handle) )
{
VertexLayoutHandle layoutHandle = findOrCreateVertexLayout(_layout);
if (!isValid(layoutHandle) )
{
BX_TRACE("WARNING: Failed to allocate vertex layout handle (BGFX_CONFIG_MAX_VERTEX_LAYOUTS, max: %d).", BGFX_CONFIG_MAX_VERTEX_LAYOUTS);
m_vertexBufferHandle.free(handle.idx);
return BGFX_INVALID_HANDLE;
}
VertexBuffer& vb = m_vertexBuffers.alloc(handle.idx);
m_vertexLayoutRef.add(vb, layoutHandle, _layout.m_hash);
vb.m_size = _mem->size;
vb.m_stride = _layout.m_stride;
vb.m_flags = _flags;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateVertexBuffer);
cmdbuf.write(handle);
cmdbuf.write(_mem);
cmdbuf.write(layoutHandle);
cmdbuf.write(_flags);
setDebugNameForHandle(handle);
return handle;
}
BX_TRACE("WARNING: Failed to allocate vertex buffer handle (BGFX_CONFIG_MAX_VERTEX_BUFFERS, max: %d).", BGFX_CONFIG_MAX_VERTEX_BUFFERS);
release(_mem);
return BGFX_INVALID_HANDLE;
}
BGFX_API_FUNC(void setName(VertexBufferHandle _handle, const bx::StringView& _name) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("setName", m_vertexBufferHandle, _handle);
VertexBuffer& ref = m_vertexBuffers[_handle.idx];
ref.m_name.set(_name);
setNameForHandle(_handle, _name);
}
BGFX_API_FUNC(void destroyVertexBuffer(VertexBufferHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyVertexBuffer", m_vertexBufferHandle, _handle);
bool ok = m_submit->free(_handle); BX_UNUSED(ok);
BX_ASSERT(ok, "Vertex buffer handle %d is already destroyed!", _handle.idx);
VertexBuffer& ref = m_vertexBuffers[_handle.idx];
ref.m_name.clear();
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyVertexBuffer);
cmdbuf.write(_handle);
}
void destroyVertexBufferInternal(VertexBufferHandle _handle)
{
VertexLayoutHandle layoutHandle = m_vertexLayoutRef.release(m_vertexBuffers[_handle.idx]);
if (isValid(layoutHandle) )
{
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyVertexLayout);
cmdbuf.write(layoutHandle);
m_render->free(layoutHandle);
}
m_vertexBuffers.release(_handle.idx);
m_vertexBufferHandle.free(_handle.idx);
}
uint64_t allocDynamicIndexBuffer(uint32_t _size, uint16_t _flags)
{
uint64_t ptr = m_dynIndexBufferAllocator.alloc(_size);
if (ptr == NonLocalAllocator::kInvalidBlock)
{
IndexBufferHandle indexBufferHandle = { m_indexBufferHandle.alloc() };
if (!isValid(indexBufferHandle) )
{
BX_TRACE("Failed to allocate index buffer handle.");
return NonLocalAllocator::kInvalidBlock;
}
const uint32_t allocSize = bx::max<uint32_t>(BGFX_CONFIG_DYNAMIC_INDEX_BUFFER_SIZE, bx::alignUp(_size, 1<<20) );
IndexBuffer& ib = m_indexBuffers.alloc(indexBufferHandle.idx);
ib.m_size = allocSize;
ib.m_flags = _flags;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateDynamicIndexBuffer);
cmdbuf.write(indexBufferHandle);
cmdbuf.write(allocSize);
cmdbuf.write(_flags);
m_dynIndexBufferAllocator.add(uint64_t(indexBufferHandle.idx) << 32, allocSize);
ptr = m_dynIndexBufferAllocator.alloc(_size);
}
return ptr;
}
uint64_t allocIndexBuffer(uint32_t _size, uint16_t _flags)
{
IndexBufferHandle indexBufferHandle = { m_indexBufferHandle.alloc() };
if (!isValid(indexBufferHandle) )
{
BX_TRACE("Failed to allocate index buffer handle.");
return NonLocalAllocator::kInvalidBlock;
}
IndexBuffer& ib = m_indexBuffers.alloc(indexBufferHandle.idx);
ib.m_size = _size;
ib.m_flags = _flags;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateDynamicIndexBuffer);
cmdbuf.write(indexBufferHandle);
cmdbuf.write(_size);
cmdbuf.write(_flags);
setDebugNameForHandle(indexBufferHandle, "Dynamic Index Buffer");
return uint64_t(indexBufferHandle.idx) << 32;
}
BGFX_API_FUNC(DynamicIndexBufferHandle createDynamicIndexBuffer(uint32_t _num, uint16_t _flags) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
DynamicIndexBufferHandle handle = { m_dynamicIndexBufferHandle.alloc() };
if (!isValid(handle) )
{
BX_TRACE("Failed to allocate dynamic index buffer handle.");
return handle;
}
const uint32_t indexSize = 0 == (_flags & BGFX_BUFFER_INDEX32) ? 2 : 4;
const uint32_t size = bx::alignUp(_num*indexSize, 16);
const uint64_t ptr = (0 != (_flags & BGFX_BUFFER_COMPUTE_READ_WRITE) )
? allocIndexBuffer(size, _flags)
: allocDynamicIndexBuffer(size, _flags)
;
if (ptr == NonLocalAllocator::kInvalidBlock)
{
m_dynamicIndexBufferHandle.free(handle.idx);
return BGFX_INVALID_HANDLE;
}
DynamicIndexBuffer& dib = m_dynamicIndexBuffers.alloc(handle.idx);
dib.m_handle.idx = uint16_t(ptr>>32);
dib.m_offset = uint32_t(ptr);
dib.m_size = _num * indexSize;
dib.m_startIndex = bx::strideAlign(dib.m_offset, indexSize)/indexSize;
dib.m_flags = _flags;
return handle;
}
BGFX_API_FUNC(DynamicIndexBufferHandle createDynamicIndexBuffer(const Memory* _mem, uint16_t _flags) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BX_ASSERT(0 == (_flags & BGFX_BUFFER_COMPUTE_WRITE), "Can't initialize compute write buffer from CPU.");
const uint32_t indexSize = 0 == (_flags & BGFX_BUFFER_INDEX32) ? 2 : 4;
DynamicIndexBufferHandle handle = createDynamicIndexBuffer(_mem->size/indexSize, _flags);
if (!isValid(handle) )
{
release(_mem);
return BGFX_INVALID_HANDLE;
}
update(handle, 0, _mem);
return handle;
}
BGFX_API_FUNC(void update(DynamicIndexBufferHandle _handle, uint32_t _startIndex, const Memory* _mem) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("updateDynamicIndexBuffer", m_dynamicIndexBufferHandle, _handle);
DynamicIndexBuffer& dib = m_dynamicIndexBuffers[_handle.idx];
BX_ASSERT(0 == (dib.m_flags & BGFX_BUFFER_COMPUTE_WRITE), "Can't update GPU write buffer from CPU.");
const uint32_t indexSize = 0 == (dib.m_flags & BGFX_BUFFER_INDEX32) ? 2 : 4;
if (dib.m_size < _mem->size
&& 0 != (dib.m_flags & BGFX_BUFFER_ALLOW_RESIZE) )
{
destroy(dib);
const uint64_t ptr = (0 != (dib.m_flags & BGFX_BUFFER_COMPUTE_READ) )
? allocIndexBuffer(_mem->size, dib.m_flags)
: allocDynamicIndexBuffer(_mem->size, dib.m_flags)
;
dib.m_handle.idx = uint16_t(ptr>>32);
dib.m_offset = uint32_t(ptr);
dib.m_size = _mem->size;
dib.m_startIndex = bx::strideAlign(dib.m_offset, indexSize)/indexSize;
}
const uint32_t offset = (dib.m_startIndex + _startIndex)*indexSize;
const uint32_t size = bx::min<uint32_t>(offset
+ bx::min(bx::satSub<uint32_t>(dib.m_size, _startIndex*indexSize), _mem->size)
, m_indexBuffers[dib.m_handle.idx].m_size) - offset
;
BX_ASSERT(_mem->size <= size, "Truncating dynamic index buffer update (size %d, mem size %d)."
, size
, _mem->size
);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::UpdateDynamicIndexBuffer);
cmdbuf.write(dib.m_handle);
cmdbuf.write(offset);
cmdbuf.write(size);
cmdbuf.write(_mem);
}
BGFX_API_FUNC(void destroyDynamicIndexBuffer(DynamicIndexBufferHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyDynamicIndexBuffer", m_dynamicIndexBufferHandle, _handle);
m_freeDynamicIndexBuffer.queue(_handle);
}
void destroy(const DynamicIndexBuffer& _dib)
{
if (0 != (_dib.m_flags & BGFX_BUFFER_COMPUTE_READ_WRITE) )
{
destroyIndexBuffer(_dib.m_handle);
}
else
{
m_dynIndexBufferAllocator.free(uint64_t(_dib.m_handle.idx) << 32 | _dib.m_offset);
for (uint64_t ptr = m_dynIndexBufferAllocator.removeOrphaned(); 0 != ptr; ptr = m_dynIndexBufferAllocator.removeOrphaned() )
{
IndexBufferHandle handle = { uint16_t(ptr >> 32) };
destroyIndexBuffer(handle);
}
}
}
void destroyDynamicIndexBufferInternal(DynamicIndexBufferHandle _handle)
{
DynamicIndexBuffer& dib = m_dynamicIndexBuffers[_handle.idx];
destroy(dib);
dib.reset();
m_dynamicIndexBuffers.release(_handle.idx);
m_dynamicIndexBufferHandle.free(_handle.idx);
}
uint64_t allocDynamicVertexBuffer(uint32_t _size, uint16_t _flags)
{
uint64_t ptr = m_dynVertexBufferAllocator.alloc(_size);
if (ptr == NonLocalAllocator::kInvalidBlock)
{
VertexBufferHandle vertexBufferHandle = { m_vertexBufferHandle.alloc() };
if (!isValid(vertexBufferHandle) )
{
BX_TRACE("Failed to allocate dynamic vertex buffer handle.");
return NonLocalAllocator::kInvalidBlock;
}
const uint32_t allocSize = bx::max<uint32_t>(BGFX_CONFIG_DYNAMIC_VERTEX_BUFFER_SIZE, bx::alignUp(_size, 1<<20) );
VertexBuffer& vb = m_vertexBuffers.alloc(vertexBufferHandle.idx);
vb.m_size = allocSize;
vb.m_stride = 0;
vb.m_flags = _flags;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateDynamicVertexBuffer);
cmdbuf.write(vertexBufferHandle);
cmdbuf.write(allocSize);
cmdbuf.write(_flags);
m_dynVertexBufferAllocator.add(uint64_t(vertexBufferHandle.idx) << 32, allocSize);
ptr = m_dynVertexBufferAllocator.alloc(_size);
}
return ptr;
}
uint64_t allocVertexBuffer(uint32_t _size, uint16_t _flags)
{
VertexBufferHandle vertexBufferHandle = { m_vertexBufferHandle.alloc() };
if (!isValid(vertexBufferHandle) )
{
BX_TRACE("WARNING: Failed to allocate vertex buffer handle (BGFX_CONFIG_MAX_VERTEX_BUFFERS, max: %d).", BGFX_CONFIG_MAX_VERTEX_BUFFERS);
return NonLocalAllocator::kInvalidBlock;
}
VertexBuffer& vb = m_vertexBuffers.alloc(vertexBufferHandle.idx);
vb.m_size = _size;
vb.m_stride = 0;
vb.m_flags = _flags;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateDynamicVertexBuffer);
cmdbuf.write(vertexBufferHandle);
cmdbuf.write(_size);
cmdbuf.write(_flags);
setDebugNameForHandle(vertexBufferHandle, "Dynamic Vertex Buffer");
return uint64_t(vertexBufferHandle.idx)<<32;
}
BGFX_API_FUNC(DynamicVertexBufferHandle createDynamicVertexBuffer(uint32_t _num, const VertexLayout& _layout, uint16_t _flags) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
VertexLayoutHandle layoutHandle = findOrCreateVertexLayout(_layout);
if (!isValid(layoutHandle) )
{
BX_TRACE("WARNING: Failed to allocate vertex layout handle (BGFX_CONFIG_MAX_VERTEX_LAYOUTS, max: %d).", BGFX_CONFIG_MAX_VERTEX_LAYOUTS);
return BGFX_INVALID_HANDLE;
}
DynamicVertexBufferHandle handle = { m_dynamicVertexBufferHandle.alloc() };
if (!isValid(handle) )
{
BX_TRACE("WARNING: Failed to allocate dynamic vertex buffer handle (BGFX_CONFIG_MAX_DYNAMIC_VERTEX_BUFFERS, max: %d).", BGFX_CONFIG_MAX_DYNAMIC_VERTEX_BUFFERS);
return BGFX_INVALID_HANDLE;
}
const uint32_t size = bx::strideAlign<16>(_num*_layout.m_stride, _layout.m_stride)+_layout.m_stride;
const uint64_t ptr = (0 != (_flags & BGFX_BUFFER_COMPUTE_READ_WRITE) )
? allocVertexBuffer(size, _flags)
: allocDynamicVertexBuffer(size, _flags)
;
if (ptr == NonLocalAllocator::kInvalidBlock)
{
m_dynamicVertexBufferHandle.free(handle.idx);
return BGFX_INVALID_HANDLE;
}
DynamicVertexBuffer& dvb = m_dynamicVertexBuffers.alloc(handle.idx);
dvb.m_handle.idx = uint16_t(ptr>>32);
dvb.m_offset = uint32_t(ptr);
dvb.m_size = _num * _layout.m_stride;
dvb.m_startVertex = bx::strideAlign(dvb.m_offset, _layout.m_stride)/_layout.m_stride;
dvb.m_numVertices = _num;
dvb.m_stride = _layout.m_stride;
dvb.m_flags = _flags;
m_vertexLayoutRef.add(dvb, layoutHandle, _layout.m_hash);
return handle;
}
BGFX_API_FUNC(DynamicVertexBufferHandle createDynamicVertexBuffer(const Memory* _mem, const VertexLayout& _layout, uint16_t _flags) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BX_ASSERT(0 == (_flags & BGFX_BUFFER_COMPUTE_WRITE), "Can't initialize compute write buffer from CPU.");
uint32_t numVertices = _mem->size/_layout.m_stride;
DynamicVertexBufferHandle handle = createDynamicVertexBuffer(numVertices, _layout, _flags);
if (!isValid(handle) )
{
release(_mem);
return BGFX_INVALID_HANDLE;
}
update(handle, 0, _mem);
return handle;
}
BGFX_API_FUNC(void update(DynamicVertexBufferHandle _handle, uint32_t _startVertex, const Memory* _mem) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("updateDynamicVertexBuffer", m_dynamicVertexBufferHandle, _handle);
DynamicVertexBuffer& dvb = m_dynamicVertexBuffers[_handle.idx];
BX_ASSERT(0 == (dvb.m_flags & BGFX_BUFFER_COMPUTE_WRITE), "Can't update GPU write buffer from CPU.");
if (dvb.m_size < _mem->size
&& 0 != (dvb.m_flags & BGFX_BUFFER_ALLOW_RESIZE) )
{
destroy(dvb);
const uint32_t size = bx::strideAlign<16>(_mem->size, dvb.m_stride)+dvb.m_stride;
const uint64_t ptr = (0 != (dvb.m_flags & BGFX_BUFFER_COMPUTE_READ) )
? allocVertexBuffer(size, dvb.m_flags)
: allocDynamicVertexBuffer(size, dvb.m_flags)
;
dvb.m_handle.idx = uint16_t(ptr>>32);
dvb.m_offset = uint32_t(ptr);
dvb.m_size = size;
dvb.m_numVertices = _mem->size / dvb.m_stride;
dvb.m_startVertex = bx::strideAlign(dvb.m_offset, dvb.m_stride)/dvb.m_stride;
}
const uint32_t offset = (dvb.m_startVertex + _startVertex)*dvb.m_stride;
const uint32_t size = bx::min<uint32_t>(offset
+ bx::min(bx::satSub<uint32_t>(dvb.m_size, _startVertex*dvb.m_stride), _mem->size)
, m_vertexBuffers[dvb.m_handle.idx].m_size) - offset
;
BX_ASSERT(_mem->size <= size, "Truncating dynamic vertex buffer update (size %d, mem size %d)."
, size
, _mem->size
);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::UpdateDynamicVertexBuffer);
cmdbuf.write(dvb.m_handle);
cmdbuf.write(offset);
cmdbuf.write(size);
cmdbuf.write(_mem);
}
BGFX_API_FUNC(void destroyDynamicVertexBuffer(DynamicVertexBufferHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyDynamicVertexBuffer", m_dynamicVertexBufferHandle, _handle);
m_freeDynamicVertexBuffer.queue(_handle);
}
void destroy(const DynamicVertexBuffer& _dvb)
{
if (0 != (_dvb.m_flags & BGFX_BUFFER_COMPUTE_READ_WRITE) )
{
destroyVertexBuffer(_dvb.m_handle);
}
else
{
m_dynVertexBufferAllocator.free(uint64_t(_dvb.m_handle.idx) << 32 | _dvb.m_offset);
for (uint64_t ptr = m_dynVertexBufferAllocator.removeOrphaned(); 0 != ptr; ptr = m_dynVertexBufferAllocator.removeOrphaned() )
{
VertexBufferHandle handle = { uint16_t(ptr >> 32) };
destroyVertexBuffer(handle);
}
}
}
void destroyDynamicVertexBufferInternal(DynamicVertexBufferHandle _handle)
{
VertexLayoutHandle layoutHandle = m_vertexLayoutRef.release(m_dynamicVertexBuffers[_handle.idx]);
BGFX_CHECK_HANDLE_INVALID_OK("destroyDynamicVertexBufferInternal", m_layoutHandle, layoutHandle);
if (isValid(layoutHandle) )
{
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyVertexLayout);
cmdbuf.write(layoutHandle);
m_render->free(layoutHandle);
}
DynamicVertexBuffer& dvb = m_dynamicVertexBuffers[_handle.idx];
destroy(dvb);
dvb.reset();
m_dynamicVertexBuffers.release(_handle.idx);
m_dynamicVertexBufferHandle.free(_handle.idx);
}
BGFX_API_FUNC(uint32_t getAvailTransientIndexBuffer(uint32_t _num, bool _index32) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
const bool isIndex16 = !_index32;
const uint16_t indexSize = isIndex16 ? 2 : 4;
return m_submit->getAvailTransientIndexBuffer(_num, indexSize);
}
BGFX_API_FUNC(uint32_t getAvailTransientVertexBuffer(uint32_t _num, uint16_t _stride) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
return m_submit->getAvailTransientVertexBuffer(_num, _stride);
}
TransientIndexBuffer* createTransientIndexBuffer(uint32_t _size)
{
TransientIndexBuffer* tib = NULL;
IndexBufferHandle handle = { m_indexBufferHandle.alloc() };
BX_WARN(isValid(handle), "Failed to allocate transient index buffer handle.");
if (isValid(handle) )
{
m_indexBuffers.alloc(handle.idx);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateDynamicIndexBuffer);
cmdbuf.write(handle);
cmdbuf.write(_size);
uint16_t flags = BGFX_BUFFER_NONE;
cmdbuf.write(flags);
const uint32_t size = 0
+ bx::alignUp<uint32_t>(sizeof(TransientIndexBuffer), 16)
+ bx::alignUp(_size, 16)
;
tib = (TransientIndexBuffer*)bx::alignedAlloc(g_allocator, size, 16);
tib->data = (uint8_t *)tib + bx::alignUp(sizeof(TransientIndexBuffer), 16);
tib->size = _size;
tib->handle = handle;
setDebugNameForHandle(handle, "Transient Index Buffer");
}
return tib;
}
void destroyTransientIndexBuffer(TransientIndexBuffer* _tib)
{
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyDynamicIndexBuffer);
cmdbuf.write(_tib->handle);
m_submit->free(_tib->handle);
bx::alignedFree(g_allocator, _tib, 16);
}
BGFX_API_FUNC(void allocTransientIndexBuffer(TransientIndexBuffer* _tib, uint32_t _num, bool _index32) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
const bool isIndex16 = !_index32;
const uint16_t indexSize = isIndex16 ? 2 : 4;
const uint32_t offset = m_submit->allocTransientIndexBuffer(_num, indexSize);
TransientIndexBuffer& tib = *m_submit->m_transientIb;
_tib->data = &tib.data[offset];
_tib->size = _num * indexSize;
_tib->handle = tib.handle;
_tib->startIndex = bx::strideAlign(offset, indexSize) / indexSize;
_tib->isIndex16 = isIndex16;
}
TransientVertexBuffer* createTransientVertexBuffer(uint32_t _size, const VertexLayout* _layout = NULL)
{
TransientVertexBuffer* tvb = NULL;
VertexBufferHandle handle = { m_vertexBufferHandle.alloc() };
BX_WARN(isValid(handle), "Failed to allocate transient vertex buffer handle.");
if (isValid(handle) )
{
m_vertexBuffers.alloc(handle.idx);
uint16_t stride = 0;
VertexLayoutHandle layoutHandle = BGFX_INVALID_HANDLE;
if (NULL != _layout)
{
layoutHandle = findOrCreateVertexLayout(*_layout);
m_vertexLayoutRef.add(m_vertexBuffers[handle.idx], layoutHandle, _layout->m_hash);
stride = _layout->m_stride;
}
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateDynamicVertexBuffer);
cmdbuf.write(handle);
cmdbuf.write(_size);
uint16_t flags = BGFX_BUFFER_NONE;
cmdbuf.write(flags);
const uint32_t size = 0
+ bx::alignUp<uint32_t>(sizeof(TransientVertexBuffer), 16)
+ bx::alignUp(_size, 16)
;
tvb = (TransientVertexBuffer*)bx::alignedAlloc(g_allocator, size, 16);
tvb->data = (uint8_t *)tvb + bx::alignUp(sizeof(TransientVertexBuffer), 16);
tvb->size = _size;
tvb->startVertex = 0;
tvb->stride = stride;
tvb->handle = handle;
tvb->layoutHandle = layoutHandle;
setDebugNameForHandle(handle, "Transient Vertex Buffer");
}
return tvb;
}
void destroyTransientVertexBuffer(TransientVertexBuffer* _tvb)
{
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyDynamicVertexBuffer);
cmdbuf.write(_tvb->handle);
m_submit->free(_tvb->handle);
bx::alignedFree(g_allocator, _tvb, 16);
}
BGFX_API_FUNC(void allocTransientVertexBuffer(TransientVertexBuffer* _tvb, uint32_t _num, VertexLayoutHandle _layoutHandle, uint16_t _stride) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
const uint32_t offset = m_submit->allocTransientVertexBuffer(_num, _stride);
const TransientVertexBuffer& dvb = *m_submit->m_transientVb;
_tvb->data = &dvb.data[offset];
_tvb->size = _num * _stride;
_tvb->startVertex = bx::strideAlign(offset, _stride)/_stride;
_tvb->stride = _stride;
_tvb->handle = dvb.handle;
_tvb->layoutHandle = _layoutHandle;
}
BGFX_API_FUNC(void allocInstanceDataBuffer(InstanceDataBuffer* _idb, uint32_t _num, uint16_t _stride) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
const uint16_t stride = bx::alignUp(_stride, 16);
const uint32_t offset = m_submit->allocTransientVertexBuffer(_num, stride);
TransientVertexBuffer& dvb = *m_submit->m_transientVb;
_idb->data = &dvb.data[offset];
_idb->size = _num * stride;
_idb->offset = offset;
_idb->num = _num;
_idb->stride = stride;
_idb->handle = dvb.handle;
}
IndirectBufferHandle createIndirectBuffer(uint32_t _num)
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BX_UNUSED(_num);
IndirectBufferHandle handle = { m_vertexBufferHandle.alloc() };
BX_WARN(isValid(handle), "Failed to allocate draw indirect buffer handle.");
if (isValid(handle) )
{
const uint32_t size = _num * BGFX_CONFIG_DRAW_INDIRECT_STRIDE;
const uint16_t flags = BGFX_BUFFER_DRAW_INDIRECT;
VertexBuffer& vb = m_vertexBuffers.alloc(handle.idx);
vb.m_size = size;
vb.m_stride = BGFX_CONFIG_DRAW_INDIRECT_STRIDE;
vb.m_flags = flags;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateDynamicVertexBuffer);
cmdbuf.write(handle);
cmdbuf.write(size);
cmdbuf.write(flags);
}
return handle;
}
void destroyIndirectBuffer(IndirectBufferHandle _handle)
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
VertexBufferHandle handle = { _handle.idx };
BGFX_CHECK_HANDLE("destroyDrawIndirectBuffer", m_vertexBufferHandle, handle);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyDynamicVertexBuffer);
cmdbuf.write(handle);
m_submit->free(handle);
}
BGFX_API_FUNC(ShaderHandle createShader(const Memory* _mem) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
bx::MemoryReader reader(_mem->data, _mem->size);
bx::Error err;
uint32_t magic;
bx::read(&reader, magic, &err);
if (!err.isOk() )
{
BX_TRACE("Couldn't read shader signature!");
release(_mem);
return BGFX_INVALID_HANDLE;
}
if (!isShaderBin(magic) )
{
BX_TRACE("Invalid shader signature! %c%c%c%d."
, ( (uint8_t*)&magic)[0]
, ( (uint8_t*)&magic)[1]
, ( (uint8_t*)&magic)[2]
, ( (uint8_t*)&magic)[3]
);
release(_mem);
return BGFX_INVALID_HANDLE;
}
if (isShaderType(magic, 'C')
&& 0 == (g_caps.supported & BGFX_CAPS_COMPUTE) )
{
BX_TRACE("Creating compute shader but compute is not supported!");
release(_mem);
return BGFX_INVALID_HANDLE;
}
if (isShaderVerLess(magic, 12) )
{
BX_TRACE("Unsupported shader binary version %d, expected 12 or newer. Recompile shaders with the matching shaderc."
, uint8_t(magic>>24)
);
release(_mem);
return BGFX_INVALID_HANDLE;
}
const uint32_t shaderHash = bx::hash<bx::HashMurmur2A>(_mem->data, _mem->size);
const uint16_t idx = m_shaderHashMap.find(shaderHash);
if (kInvalidHandle != idx)
{
ShaderHandle handle = { idx };
shaderIncRef(handle);
release(_mem);
return handle;
}
uint32_t hashIn;
bx::read(&reader, hashIn, &err);
uint32_t hashOut;
if (isShaderVerLess(magic, 6) )
{
hashOut = hashIn;
}
else
{
bx::read(&reader, hashOut, &err);
}
{
uint32_t rawSrvMask, rawUavMask;
readRawBindings(&reader, rawSrvMask, rawUavMask, &err);
BX_UNUSED(rawSrvMask, rawUavMask);
}
uint16_t count;
bx::read(&reader, count, &err);
if (!err.isOk() )
{
BX_TRACE("Corrupted shader binary!");
release(_mem);
return BGFX_INVALID_HANDLE;
}
ShaderHandle handle = { m_shaderHandle.alloc() };
if (!isValid(handle) )
{
BX_TRACE("Failed to allocate shader handle.");
release(_mem);
return BGFX_INVALID_HANDLE;
}
bool ok = m_shaderHashMap.insert(shaderHash, handle.idx);
BX_ASSERT(ok, "Shader already exists!"); BX_UNUSED(ok);
ShaderRef& sr = m_shaderRef.alloc(handle.idx);
sr.m_refCount = 1;
sr.m_hashIn = hashIn;
sr.m_hashOut = hashOut;
sr.m_num = 0;
sr.m_uniforms = NULL;
sr.m_numSamplers = 0;
UniformHandle* uniforms = (UniformHandle*)BX_STACK_ALLOC(count*sizeof(UniformHandle) );
for (uint32_t ii = 0; ii < count; ++ii)
{
uint8_t nameSize = 0;
bx::read(&reader, nameSize, &err);
char name[256];
bx::read(&reader, &name, nameSize, &err);
name[nameSize] = '\0';
uint8_t type = 0;
bx::read(&reader, type, &err);
type &= ~kUniformMask;
const bool isSampler = UniformType::Sampler == UniformType::Enum(type);
uint8_t num;
bx::read(&reader, num, &err);
uint16_t regIndex;
bx::read(&reader, regIndex, &err);
uint16_t regCount;
bx::read(&reader, regCount, &err);
uint8_t texComponent = 0;
uint8_t texDimension = 0;
if (!isShaderVerLess(magic, 8) )
{
bx::read(&reader, texComponent, &err);
bx::read(&reader, texDimension, &err);
}
BX_UNUSED(texComponent);
if (!isShaderVerLess(magic, 10) )
{
uint16_t texFormat = 0;
bx::read(&reader, texFormat, &err);
}
PredefinedUniform::Enum predefined = nameToPredefinedUniformEnum(name);
if (PredefinedUniform::Count == predefined
&& UniformType::End != UniformType::Enum(type) )
{
const UniformHandle uniform = createUniform(name, UniformFreq::Count, UniformType::Enum(type), num);
uniforms[sr.m_num] = uniform;
sr.m_num++;
if (isSampler
&& sr.m_numSamplers < BX_COUNTOF(sr.m_samplerDimension) )
{
sr.m_samplerUniform[sr.m_numSamplers] = uniform.idx;
sr.m_samplerDimension[sr.m_numSamplers] = uint8_t(idToTextureDimension(texDimension) );
sr.m_numSamplers++;
}
}
}
if (0 != sr.m_num)
{
uint32_t size = sr.m_num*sizeof(UniformHandle);
sr.m_uniforms = (UniformHandle*)bx::alloc(g_allocator, size);
bx::memCopy(sr.m_uniforms, uniforms, size);
}
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateShader);
cmdbuf.write(handle);
cmdbuf.write(_mem);
setDebugNameForHandle(handle);
return handle;
}
BGFX_API_FUNC(uint16_t getShaderUniforms(ShaderHandle _handle, UniformHandle* _uniforms, uint16_t _max) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
if (!isValid(_handle) )
{
BX_WARN(false, "Passing invalid shader handle to bgfx::getShaderUniforms.");
return 0;
}
ShaderRef& sr = m_shaderRef[_handle.idx];
if (NULL != _uniforms)
{
bx::memCopy(_uniforms, sr.m_uniforms, bx::min<uint16_t>(_max, sr.m_num)*sizeof(UniformHandle) );
}
return sr.m_num;
}
void setNameForHandle(Handle _handle, const bx::StringView& _name)
{
char tmp[1024];
uint16_t len = 1+(uint16_t)bx::snprintf(tmp, BX_COUNTOF(tmp)
, "%sH %d: %S"
, _handle.getTypeName().abrvName
, _handle.idx
, &_name
);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::SetName);
cmdbuf.write(_handle);
cmdbuf.write(len);
cmdbuf.write(tmp, len);
}
void setDebugNameForHandle(Handle _handle, const bx::StringView& _name = "")
{
if (BX_ENABLED(BGFX_CONFIG_DEBUG) )
{
setNameForHandle(_handle, _name);
}
}
BGFX_API_FUNC(void setName(ShaderHandle _handle, const bx::StringView& _name) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("setName", m_shaderHandle, _handle);
ShaderRef& sr = m_shaderRef[_handle.idx];
sr.m_name.set(_name);
setNameForHandle(_handle, _name);
}
BGFX_API_FUNC(void destroyShader(ShaderHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyShader", m_shaderHandle, _handle);
if (!isValid(_handle) )
{
BX_WARN(false, "Passing invalid shader handle to bgfx::destroyShader.");
return;
}
shaderDecRef(_handle);
}
void shaderTakeOwnership(ShaderHandle _handle)
{
shaderDecRef(_handle);
}
void shaderIncRef(ShaderHandle _handle)
{
ShaderRef& sr = m_shaderRef[_handle.idx];
++sr.m_refCount;
}
void shaderDecRef(ShaderHandle _handle)
{
ShaderRef& sr = m_shaderRef[_handle.idx];
int32_t refs = --sr.m_refCount;
if (0 == refs)
{
bool ok = m_submit->free(_handle); BX_UNUSED(ok);
BX_ASSERT(ok, "Shader handle %d is already destroyed!", _handle.idx);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyShader);
cmdbuf.write(_handle);
if (0 != sr.m_num)
{
for (uint32_t ii = 0, num = sr.m_num; ii < num; ++ii)
{
destroyUniform(sr.m_uniforms[ii]);
}
bx::free(g_allocator, sr.m_uniforms);
sr.m_uniforms = NULL;
sr.m_num = 0;
}
m_shaderHashMap.removeByHandle(_handle.idx);
}
}
BGFX_API_FUNC(ProgramHandle createProgram(ShaderHandle _vsh, ShaderHandle _fsh, bool _destroyShaders) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
if (!isValid(_vsh)
|| !isValid(_fsh) )
{
BX_TRACE("Vertex/fragment shader is invalid (vsh %d, fsh %d).", _vsh.idx, _fsh.idx);
return BGFX_INVALID_HANDLE;
}
ProgramHandle handle = { m_programHashMap.find(uint32_t(_fsh.idx<<16)|_vsh.idx) };
if (isValid(handle) )
{
ProgramRef& pr = m_programRef[handle.idx];
++pr.m_refCount;
shaderIncRef(pr.m_vsh);
shaderIncRef(pr.m_fsh);
}
else
{
const ShaderRef& vsr = m_shaderRef[_vsh.idx];
const ShaderRef& fsr = m_shaderRef[_fsh.idx];
if (vsr.m_hashOut != fsr.m_hashIn)
{
BX_TRACE("Vertex shader output doesn't match fragment shader input.");
return BGFX_INVALID_HANDLE;
}
for (uint32_t ii = 0; ii < vsr.m_numSamplers; ++ii)
{
const uint8_t vsDim = vsr.m_samplerDimension[ii];
if (uint8_t(TextureDimension::Count) == vsDim)
{
continue;
}
for (uint32_t jj = 0; jj < fsr.m_numSamplers; ++jj)
{
if (vsr.m_samplerUniform[ii] != fsr.m_samplerUniform[jj])
{
continue;
}
const uint8_t fsDim = fsr.m_samplerDimension[jj];
if (uint8_t(TextureDimension::Count) != fsDim
&& vsDim != fsDim)
{
BX_TRACE("Vertex and fragment shader declare different texture dimension for sampler '%S' (vsh %d, fsh %d)."
, &m_uniformRef[vsr.m_samplerUniform[ii] ].m_name
, vsDim
, fsDim
);
return BGFX_INVALID_HANDLE;
}
}
}
handle.idx = m_programHandle.alloc();
BX_WARN(isValid(handle), "Failed to allocate program handle.");
if (isValid(handle) )
{
shaderIncRef(_vsh);
shaderIncRef(_fsh);
ProgramRef& pr = m_programRef[handle.idx];
pr.m_vsh = _vsh;
pr.m_fsh = _fsh;
pr.m_refCount = 1;
const uint32_t key = uint32_t(_fsh.idx<<16)|_vsh.idx;
bool ok = m_programHashMap.insert(key, handle.idx);
BX_ASSERT(ok, "Program already exists (key: %x, handle: %3d)!", key, handle.idx); BX_UNUSED(ok);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateProgram);
cmdbuf.write(handle);
cmdbuf.write(_vsh);
cmdbuf.write(_fsh);
}
}
if (_destroyShaders)
{
shaderTakeOwnership(_vsh);
shaderTakeOwnership(_fsh);
}
return handle;
}
BGFX_API_FUNC(ProgramHandle createProgram(ShaderHandle _vsh, bool _destroyShader) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
if (!isValid(_vsh) )
{
BX_WARN(false, "Compute shader is invalid (vsh %d).", _vsh.idx);
return BGFX_INVALID_HANDLE;
}
ProgramHandle handle = { m_programHashMap.find(_vsh.idx) };
if (isValid(handle) )
{
ProgramRef& pr = m_programRef[handle.idx];
++pr.m_refCount;
shaderIncRef(pr.m_vsh);
}
else
{
handle.idx = m_programHandle.alloc();
BX_WARN(isValid(handle), "Failed to allocate program handle.");
if (isValid(handle) )
{
shaderIncRef(_vsh);
ProgramRef& pr = m_programRef[handle.idx];
pr.m_vsh = _vsh;
ShaderHandle fsh = BGFX_INVALID_HANDLE;
pr.m_fsh = fsh;
pr.m_refCount = 1;
const uint32_t key = uint32_t(_vsh.idx);
bool ok = m_programHashMap.insert(key, handle.idx);
BX_ASSERT(ok, "Program already exists (key: %x, handle: %3d)!", key, handle.idx); BX_UNUSED(ok);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateProgram);
cmdbuf.write(handle);
cmdbuf.write(_vsh);
cmdbuf.write(fsh);
}
}
if (_destroyShader)
{
shaderTakeOwnership(_vsh);
}
return handle;
}
BGFX_API_FUNC(void destroyProgram(ProgramHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyProgram", m_programHandle, _handle);
ProgramRef& pr = m_programRef[_handle.idx];
shaderDecRef(pr.m_vsh);
if (isValid(pr.m_fsh) )
{
shaderDecRef(pr.m_fsh);
}
int32_t refs = --pr.m_refCount;
if (0 == refs)
{
bool ok = m_submit->free(_handle); BX_UNUSED(ok);
BX_ASSERT(ok, "Program handle %d is already destroyed!", _handle.idx);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyProgram);
cmdbuf.write(_handle);
m_programHashMap.removeByHandle(_handle.idx);
}
}
BGFX_API_FUNC(TextureHandle createTexture(const Memory* _mem, uint64_t _flags, uint8_t _skip, TextureInfo* _info, BackbufferRatio::Enum _ratio, bool _immutable, uint64_t _external) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
TextureInfo ti;
if (NULL == _info)
{
_info = &ti;
}
bimg::ImageContainer imageContainer;
if (bimg::imageParse(imageContainer, _mem->data, _mem->size) )
{
calcTextureSize(*_info
, (uint16_t)imageContainer.m_width
, (uint16_t)imageContainer.m_height
, (uint16_t)imageContainer.m_depth
, imageContainer.m_cubeMap
, imageContainer.m_numMips > 1
, imageContainer.m_numLayers
, TextureFormat::Enum(imageContainer.m_format)
);
}
else
{
_info->format = TextureFormat::Unknown;
_info->storageSize = 0;
_info->width = 0;
_info->height = 0;
_info->depth = 0;
_info->numMips = 0;
_info->bitsPerPixel = 0;
_info->cubeMap = false;
return BGFX_INVALID_HANDLE;
}
_flags |= imageContainer.m_srgb ? BGFX_TEXTURE_SRGB : 0;
TextureHandle handle = { m_textureHandle.alloc() };
BX_WARN(isValid(handle), "Failed to allocate texture handle.");
if (!isValid(handle) )
{
release(_mem);
return BGFX_INVALID_HANDLE;
}
TextureRef& ref = m_textureRef.alloc(handle.idx);
ref.init(
_ratio
, uint16_t(imageContainer.m_width)
, uint16_t(imageContainer.m_height)
, uint16_t(imageContainer.m_depth)
, _info->format
, _info->storageSize
, imageContainer.m_numMips
, imageContainer.m_numLayers
, 0 != (g_caps.supported & BGFX_CAPS_TEXTURE_DIRECT_ACCESS)
, _immutable
, imageContainer.m_cubeMap
, _flags
);
if (ref.isRt() )
{
m_rtMemoryUsed += int64_t(ref.m_storageSize);
}
else
{
m_textureMemoryUsed += int64_t(ref.m_storageSize);
}
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateTexture);
cmdbuf.write(handle);
cmdbuf.write(_mem);
cmdbuf.write(_flags);
cmdbuf.write(_skip);
cmdbuf.write(_external);
setDebugNameForHandle(handle);
return handle;
}
BGFX_API_FUNC(void setName(TextureHandle _handle, const bx::StringView& _name) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("setName", m_textureHandle, _handle);
TextureRef& ref = m_textureRef[_handle.idx];
ref.m_name.set(_name);
setNameForHandle(_handle, _name);
}
void setDirectAccessPtr(TextureHandle _handle, void* _ptr)
{
TextureRef& ref = m_textureRef[_handle.idx];
ref.m_ptr = _ptr;
}
BGFX_API_FUNC(void* getDirectAccessPtr(TextureHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("getDirectAccessPtr", m_textureHandle, _handle);
TextureRef& ref = m_textureRef[_handle.idx];
return ref.m_ptr;
}
BGFX_API_FUNC(void destroyTexture(TextureHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyTexture", m_textureHandle, _handle);
if (!isValid(_handle) )
{
BX_WARN(false, "Passing invalid texture handle to bgfx::destroyTexture");
return;
}
textureDecRef(_handle);
}
BGFX_API_FUNC(uint32_t readTexture(TextureHandle _handle, void* _data, uint16_t _layer, uint8_t _mip) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("readTexture", m_textureHandle, _handle);
const TextureRef& ref = m_textureRef[_handle.idx];
BX_ASSERT(ref.isReadBack(), "Can't read from texture which was not created with BGFX_TEXTURE_READ_BACK.");
BX_ASSERT(_mip < ref.m_numMips, "Invalid mip: %d num mips:", _mip, ref.m_numMips);
const uint16_t numLayers = uint16_t(ref.m_numLayers * (ref.m_cubeMap ? 6 : 1) );
BX_ASSERT(_layer < numLayers, "Invalid layer: %d num layers: %d", _layer, numLayers);
BX_UNUSED(ref, numLayers);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::ReadTexture);
cmdbuf.write(_handle);
cmdbuf.write(_data);
cmdbuf.write(_layer);
cmdbuf.write(_mip);
return m_submit->m_frameNum + 2;
}
BufferRef getBufferRef(const char* _desc, BufferHandle _handle)
{
BX_UNUSED(_desc);
BufferRef result;
switch (_handle.type)
{
case BufferHandle::DynamicIndexBuffer:
{
BGFX_CHECK_HANDLE(_desc, m_dynamicIndexBufferHandle, _handle);
const DynamicIndexBuffer& dib = m_dynamicIndexBuffers[_handle.idx];
result.m_handle = Handle(dib.m_handle);
result.m_offset = dib.m_offset;
result.m_size = dib.m_size;
result.m_flags = dib.m_flags;
result.m_name = &m_indexBuffers[dib.m_handle.idx].m_name;
}
break;
case BufferHandle::DynamicVertexBuffer:
{
BGFX_CHECK_HANDLE(_desc, m_dynamicVertexBufferHandle, _handle);
const DynamicVertexBuffer& dvb = m_dynamicVertexBuffers[_handle.idx];
result.m_handle = Handle(dvb.m_handle);
result.m_offset = dvb.m_offset;
result.m_size = dvb.m_size;
result.m_flags = dvb.m_flags;
result.m_name = &m_vertexBuffers[dvb.m_handle.idx].m_name;
}
break;
case BufferHandle::IndexBuffer:
{
BGFX_CHECK_HANDLE(_desc, m_indexBufferHandle, _handle);
const IndexBuffer& ib = m_indexBuffers[_handle.idx];
result.m_handle = Handle(IndexBufferHandle{ _handle.idx });
result.m_offset = 0;
result.m_size = ib.m_size;
result.m_flags = ib.m_flags;
result.m_name = &ib.m_name;
}
break;
case BufferHandle::IndirectBuffer:
case BufferHandle::VertexBuffer:
{
BGFX_CHECK_HANDLE(_desc, m_vertexBufferHandle, _handle);
const VertexBuffer& vb = m_vertexBuffers[_handle.idx];
result.m_handle = Handle(VertexBufferHandle{ _handle.idx });
result.m_offset = 0;
result.m_size = vb.m_size;
result.m_flags = vb.m_flags;
result.m_name = &vb.m_name;
}
break;
default:
BX_ASSERT(false, "%s - Invalid buffer handle type %d.", _desc, _handle.type);
result.m_handle = Handle();
result.m_offset = 0;
result.m_size = 0;
result.m_flags = 0;
result.m_name = NULL;
break;
}
return result;
}
BGFX_API_FUNC(uint32_t readBuffer(BufferHandle _handle, void* _data, uint32_t _offset, uint32_t _size) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
const BufferRef ref = getBufferRef("readBuffer", _handle);
BX_ASSERT(isBufferReadable(ref.m_flags)
, "Can't read from buffer (handle %d, '%S') which was not created with any of `BGFX_BUFFER_COMPUTE_*`, or `BGFX_BUFFER_DRAW_INDIRECT` flags."
, _handle.idx
, ref.m_name
);
BX_ASSERT(_offset <= ref.m_size
, "Read buffer offset out of range (%d > %d)."
, _offset
, ref.m_size
);
const uint32_t size = bx::min(_size, ref.m_size - _offset);
BX_WARN(size == _size || UINT32_MAX == _size
, "Read buffer size truncated (%d -> %d)."
, _size
, size
);
if (0 != size)
{
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::ReadBuffer);
cmdbuf.write(ref.m_handle);
cmdbuf.write(_data);
cmdbuf.write(ref.m_offset + _offset);
cmdbuf.write(size);
}
return m_submit->m_frameNum + 2;
}
void resizeTexture(TextureHandle _handle, uint16_t _width, uint16_t _height, uint8_t _numMips, uint16_t _numLayers)
{
TextureRef& ref = m_textureRef[_handle.idx];
BX_ASSERT(BackbufferRatio::Count != ref.m_bbRatio, "");
getTextureSizeFromRatio(BackbufferRatio::Enum(ref.m_bbRatio), _width, _height);
_numMips = calcNumMips(ref.m_flags, 1 < _numMips, _width, _height);
ref.m_width = _width;
ref.m_height = _height;
ref.m_numMips = _numMips;
ref.m_numLayers = _numLayers;
BX_TRACE("Resize %3d: %4dx%d %s"
, _handle.idx
, _width
, _height
, bimg::getName(bimg::TextureFormat::Enum(ref.m_format) )
);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::ResizeTexture);
cmdbuf.write(_handle);
cmdbuf.write(_width);
cmdbuf.write(_height);
cmdbuf.write(_numMips);
cmdbuf.write(_numLayers);
}
void textureTakeOwnership(TextureHandle _handle)
{
TextureRef& ref = m_textureRef[_handle.idx];
if (!ref.m_owned)
{
ref.m_owned = true;
textureDecRef(_handle);
}
}
void textureIncRef(TextureHandle _handle)
{
TextureRef& ref = m_textureRef[_handle.idx];
++ref.m_refCount;
}
void textureDecRef(TextureHandle _handle)
{
TextureRef& ref = m_textureRef[_handle.idx];
int32_t refs = --ref.m_refCount;
if (0 == refs)
{
ref.m_name.clear();
if (ref.isRt() )
{
m_rtMemoryUsed -= int64_t(ref.m_storageSize);
}
else
{
m_textureMemoryUsed -= int64_t(ref.m_storageSize);
}
bool ok = m_submit->free(_handle); BX_UNUSED(ok);
BX_ASSERT(ok, "Texture handle %d is already destroyed!", _handle.idx);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyTexture);
cmdbuf.write(_handle);
}
}
BGFX_API_FUNC(void updateTexture(
TextureHandle _handle
, uint8_t _side
, uint8_t _mip
, uint16_t _x
, uint16_t _y
, uint16_t _z
, uint16_t _width
, uint16_t _height
, uint16_t _depth
, uint16_t _pitch
, const Memory* _mem
) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
const TextureRef& ref = m_textureRef[_handle.idx];
if (ref.m_immutable)
{
BX_WARN(false, "Can't update immutable texture.");
release(_mem);
return;
}
{
const bimg::TextureFormat::Enum format = bimg::TextureFormat::Enum(ref.m_format);
const bimg::ImageBlockInfo& blockInfo = bimg::getBlockInfo(format);
uint32_t rectPitch = _width * blockInfo.bitsPerPixel / 8;
uint32_t numRows = _height;
if (bimg::isCompressed(format) )
{
const uint32_t blockW = bx::max<uint32_t>(1, blockInfo.blockWidth);
const uint32_t blockH = bx::max<uint32_t>(1, blockInfo.blockHeight);
rectPitch = bx::max<uint32_t>(1, bx::alignUp(_width, blockW)/blockW) * blockInfo.blockSize;
numRows = bx::max<uint32_t>(1, bx::alignUp(_height, blockH)/blockH);
}
const uint32_t srcPitch = UINT16_MAX == _pitch ? rectPitch : _pitch;
const uint32_t numSlices = bx::max<uint32_t>(1, ref.m_depth > 1 ? _depth : 1);
const uint32_t needed = (numSlices-1)*srcPitch*numRows
+ (numRows-1)*srcPitch
+ rectPitch
;
if (_mem->size < needed)
{
BX_WARN(false
, "Texture update source memory is too small (%d bytes, needs %d) "
"for a %dx%dx%d %s rect with pitch %d; skipping."
, _mem->size
, needed
, _width
, _height
, _depth
, bimg::getName(format)
, srcPitch
);
release(_mem);
return;
}
}
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::UpdateTexture);
cmdbuf.write(_handle);
cmdbuf.write(_side);
cmdbuf.write(_mip);
Rect rect;
rect.m_x = bx::narrowCast<int16_t>(_x);
rect.m_y = bx::narrowCast<int16_t>(_y);
rect.m_width = _width;
rect.m_height = _height;
cmdbuf.write(rect);
cmdbuf.write(_z);
cmdbuf.write(_depth);
cmdbuf.write(_pitch);
cmdbuf.write(_mem);
}
BGFX_API_FUNC(void clearTexture(TextureHandle _handle, uint8_t _mip, uint8_t _numMips, uint16_t _layer, uint16_t _numLayers) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::ClearTexture);
cmdbuf.write(_handle);
cmdbuf.write(_mip);
cmdbuf.write(_numMips);
cmdbuf.write(_layer);
cmdbuf.write(_numLayers);
}
BGFX_API_FUNC(FrameBufferHandle createFrameBuffer(uint8_t _num, const Attachment* _attachment, bool _destroyTextures) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
bx::ErrorAssert err;
isFrameBufferValid(_num, _attachment, &err);
if (!err.isOk() )
{
return BGFX_INVALID_HANDLE;
}
FrameBufferHandle handle = { m_frameBufferHandle.alloc() };
BX_WARN(isValid(handle), "Failed to allocate frame buffer handle.");
if (isValid(handle) )
{
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateFrameBuffer);
cmdbuf.write(handle);
cmdbuf.write(uint8_t(0) ); // attachment-based
cmdbuf.write(_num);
const TextureRef& firstTexture = m_textureRef[_attachment[0].handle.idx];
const BackbufferRatio::Enum bbRatio = BackbufferRatio::Enum(firstTexture.m_bbRatio);
FrameBufferRef& fbr = m_frameBufferRef.alloc(handle.idx);
if (BackbufferRatio::Count == bbRatio)
{
fbr.m_width = bx::max<uint16_t>(firstTexture.m_width >> _attachment[0].mip, 1);
fbr.m_height = bx::max<uint16_t>(firstTexture.m_height >> _attachment[0].mip, 1);
}
fbr.m_window = false;
bx::memSet(fbr.un.m_th, 0xff, sizeof(fbr.un.m_th) );
for (uint32_t ii = 0; ii < _num; ++ii)
{
TextureHandle texHandle = _attachment[ii].handle;
fbr.un.m_th[ii] = texHandle;
textureIncRef(texHandle);
}
cmdbuf.write(_attachment, sizeof(Attachment) * _num);
}
if (_destroyTextures)
{
for (uint32_t ii = 0; ii < _num; ++ii)
{
textureTakeOwnership(_attachment[ii].handle);
}
}
return handle;
}
static void writeSwapChain(CommandBuffer& _cmdbuf, const FrameBufferRef& _fbr)
{
_cmdbuf.write(_fbr.m_swapChain);
}
SwapChain readSwapChain(CommandBuffer& _cmdbuf)
{
SwapChain desc;
_cmdbuf.read(desc);
const SwapChain& main = m_render->m_mainSwapChain;
if (NULL == desc.ndt)
{
desc.ndt = main.ndt;
}
if (TextureFormat::Count == desc.formatColor)
{
desc.formatColor = main.formatColor;
}
if (TextureFormat::Count == desc.formatDepthStencil)
{
desc.formatDepthStencil = main.formatDepthStencil;
}
if (0 == desc.numBackBuffers)
{
desc.numBackBuffers = main.numBackBuffers;
}
if (0 == desc.maxFrameLatency)
{
desc.maxFrameLatency = main.maxFrameLatency;
}
return desc;
}
static uint32_t checkSwapChainFlags(uint32_t _flags)
{
const uint32_t maskFlags = ~(0
| (0 != (g_caps.supported & BGFX_CAPS_TRANSPARENT_BACKBUFFER) ? 0 : BGFX_SWAP_CHAIN_TRANSPARENT_BACKBUFFER)
| (0 != (g_caps.supported & BGFX_CAPS_HDR10) ? 0 : BGFX_SWAP_CHAIN_HDR10)
);
const uint32_t flags = _flags & maskFlags;
#define WARN_SWAP_CHAIN_CAPS_FLAGS(_name) \
BX_WARN( (_flags&(BGFX_SWAP_CHAIN_##_name) ) == (flags&(BGFX_SWAP_CHAIN_##_name) ) \
, "Swap chain flag `BGFX_SWAP_CHAIN_" #_name "` will be ignored, because " \
"`BGFX_CAPS_" #_name "` is not supported." \
)
WARN_SWAP_CHAIN_CAPS_FLAGS(TRANSPARENT_BACKBUFFER);
WARN_SWAP_CHAIN_CAPS_FLAGS(HDR10);
#undef WARN_SWAP_CHAIN_CAPS_FLAGS
return flags;
}
void checkSwapChainDepth(const SwapChain& _desc)
{
if (!isValid(_desc.depth) )
{
return;
}
BGFX_CHECK_HANDLE("SwapChain::depth", m_textureHandle, _desc.depth);
const TextureRef& ref = m_textureRef[_desc.depth.idx];
BX_ASSERT(ref.isRt()
, "SwapChain::depth texture must be created with BGFX_TEXTURE_RT."
);
BX_ASSERT(ref.isDepth()
, "SwapChain::depth texture format (%s) is not a depth format."
, getName(TextureFormat::Enum(ref.m_format) )
);
BX_ASSERT(BackbufferRatio::Count == ref.m_bbRatio
, "SwapChain::depth cannot be a BackbufferRatio texture, because ratio "
"resolves against the window bgfx was initialized with, not this one."
);
BX_ASSERT(ref.m_width == _desc.width && ref.m_height == _desc.height
, "SwapChain::depth is %dx%d, but the swap chain is %dx%d."
, ref.m_width
, ref.m_height
, _desc.width
, _desc.height
);
const uint32_t msaa = (_desc.flags & BGFX_SWAP_CHAIN_MSAA_MASK) >> BGFX_SWAP_CHAIN_MSAA_SHIFT;
const uint32_t numSamples = 0 == msaa ? 1 : 1<<msaa;
BX_ASSERT(ref.m_numSamples == numSamples
, "SwapChain::depth has %d sample(s), but the swap chain has %d."
, ref.m_numSamples
, numSamples
);
BX_UNUSED(ref, numSamples);
}
BGFX_API_FUNC(FrameBufferHandle createFrameBuffer(const SwapChain& _desc) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
checkSwapChainDepth(_desc);
FrameBufferHandle handle = { m_frameBufferHandle.alloc() };
BX_WARN(isValid(handle), "Failed to allocate frame buffer handle.");
if (isValid(handle) )
{
FrameBufferRef& fbr = m_frameBufferRef.alloc(handle.idx);
fbr.m_swapChain = _desc;
fbr.m_swapChain.flags = checkSwapChainFlags(_desc.flags & kSwapChainFlagMask);
fbr.m_width = uint16_t(bx::max<uint32_t>(_desc.width, 1) );
fbr.m_height = uint16_t(bx::max<uint32_t>(_desc.height, 1) );
fbr.m_window = true;
fbr.un.m_nwh = _desc.nwh;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateFrameBuffer);
cmdbuf.write(handle);
cmdbuf.write(uint8_t(1) ); // window swap chain
writeSwapChain(cmdbuf, fbr);
}
return handle;
}
BGFX_API_FUNC(void updateSwapChain(FrameBufferHandle _handle, const SwapChain& _desc) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("updateSwapChain", m_frameBufferHandle, _handle);
checkSwapChainDepth(_desc);
FrameBufferRef& fbr = m_frameBufferRef[_handle.idx];
BX_ASSERT(fbr.m_window, "Frame buffer handle %d is not a window frame buffer.", _handle.idx);
if (!fbr.m_window)
{
return;
}
fbr.m_swapChain = _desc;
fbr.m_swapChain.flags = checkSwapChainFlags(_desc.flags & kSwapChainFlagMask);
fbr.m_width = uint16_t(bx::max<uint32_t>(_desc.width, 1) );
fbr.m_height = uint16_t(bx::max<uint32_t>(_desc.height, 1) );
fbr.un.m_nwh = _desc.nwh;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::ResizeFrameBuffer);
cmdbuf.write(_handle);
writeSwapChain(cmdbuf, fbr);
}
BGFX_API_FUNC(void setName(FrameBufferHandle _handle, const bx::StringView& _name) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("setName", m_frameBufferHandle, _handle);
FrameBufferRef& fbr = m_frameBufferRef[_handle.idx];
fbr.m_name.set(_name);
// setNameForHandle(_handle, _name);
}
BGFX_API_FUNC(TextureHandle getTexture(FrameBufferHandle _handle, uint8_t _attachment) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("getTexture", m_frameBufferHandle, _handle);
const FrameBufferRef& fbr = m_frameBufferRef[_handle.idx];
if (!fbr.m_window)
{
const uint32_t attachment = bx::min<uint32_t>(_attachment, BGFX_CONFIG_MAX_FRAME_BUFFER_ATTACHMENTS);
return fbr.un.m_th[attachment];
}
return BGFX_INVALID_HANDLE;
}
BGFX_API_FUNC(void destroyFrameBuffer(FrameBufferHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyFrameBuffer", m_frameBufferHandle, _handle);
bool ok = m_submit->free(_handle); BX_UNUSED(ok);
BX_ASSERT(ok, "Frame buffer handle %d is already destroyed!", _handle.idx);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyFrameBuffer);
cmdbuf.write(_handle);
FrameBufferRef& fbr = m_frameBufferRef[_handle.idx];
fbr.m_name.clear();
if (!fbr.m_window)
{
for (uint32_t ii = 0; ii < BX_COUNTOF(fbr.un.m_th); ++ii)
{
TextureHandle th = fbr.un.m_th[ii];
if (isValid(th) )
{
textureDecRef(th);
}
}
}
}
BGFX_API_FUNC(UniformHandle createUniform(const char* _name, UniformFreq::Enum _freq, UniformType::Enum _type, uint16_t _num) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
{
bx::ErrorAssert err;
isIdentifierValid(_name, &err);
if (!err.isOk() )
{
return BGFX_INVALID_HANDLE;
}
}
_num = bx::max<uint16_t>(1, _num);
uint16_t idx = m_uniformHashMap.find(bx::hash<bx::HashMurmur2A>(_name) );
if (kInvalidHandle != idx)
{
UniformHandle handle = { idx };
UniformRef& uniform = m_uniformRef[handle.idx];
BX_ASSERT(uniform.m_type == _type
, "Uniform type mismatch (type: %d, expected %d)."
, _type
, uniform.m_type
);
const uint32_t oldsize = g_uniformTypeSize[uniform.m_type];
const uint32_t newsize = g_uniformTypeSize[_type];
if (UniformFreq::Count != _freq)
{
// Ignore shader created uniforms, and use UniformFreq when user creates uniform.
uniform.m_freq = _freq;
}
if (oldsize < newsize
|| uniform.m_num < _num)
{
uniform.m_type = oldsize < newsize ? _type : uniform.m_type;
uniform.m_num = bx::max<uint16_t>(uniform.m_num, _num);
BX_TRACE(" Resize uniform (handle %3d) `%s`, num %d", handle.idx, _name, _num);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateUniform);
cmdbuf.write(handle);
cmdbuf.write(uniform.m_type);
cmdbuf.write(uniform.m_num);
uint8_t len = bx::narrowCast<uint8_t>(bx::strLen(_name)+1);
cmdbuf.write(len);
cmdbuf.write(_name, len);
}
++uniform.m_refCount;
return handle;
}
UniformHandle handle = { m_uniformHandle.alloc() };
if (!isValid(handle) )
{
BX_TRACE("Failed to allocate uniform handle.");
return BGFX_INVALID_HANDLE;
}
BX_TRACE("Creating uniform (handle %3d) `%s`, num %d", handle.idx, _name, _num);
UniformRef& uniform = m_uniformRef.alloc(handle.idx);
uniform.m_name.set(_name);
uniform.m_refCount = 1;
uniform.m_freq = UniformFreq::Count == _freq
? UniformFreq::Draw
: _freq
;
uniform.m_type = _type;
uniform.m_num = _num;
bool ok = m_uniformHashMap.insert(bx::hash<bx::HashMurmur2A>(_name), handle.idx);
BX_ASSERT(ok, "Uniform already exists (name: %s)!", _name); BX_UNUSED(ok);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::CreateUniform);
cmdbuf.write(handle);
cmdbuf.write(_type);
cmdbuf.write(_num);
uint8_t len = bx::narrowCast<uint8_t>(bx::strLen(_name)+1);
cmdbuf.write(len);
cmdbuf.write(_name, len);
return handle;
}
BGFX_API_FUNC(void getUniformInfo(UniformHandle _handle, UniformInfo& _info) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("getUniformInfo", m_uniformHandle, _handle);
UniformRef& uniform = m_uniformRef[_handle.idx];
bx::strCopy(_info.name, sizeof(_info.name), uniform.m_name);
_info.type = uniform.m_type;
_info.num = uniform.m_num;
}
BGFX_API_FUNC(void destroyUniform(UniformHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyUniform", m_uniformHandle, _handle);
UniformRef& uniform = m_uniformRef[_handle.idx];
BX_ASSERT(uniform.m_refCount > 0, "Destroying already destroyed uniform %d.", _handle.idx);
int32_t refs = --uniform.m_refCount;
if (0 == refs)
{
bool ok = m_submit->free(_handle); BX_UNUSED(ok);
BX_ASSERT(ok, "Uniform handle %d is already destroyed!", _handle.idx);
uniform.m_name.clear();
m_uniformHashMap.removeByHandle(_handle.idx);
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::DestroyUniform);
cmdbuf.write(_handle);
}
}
BGFX_API_FUNC(OcclusionQueryHandle createOcclusionQuery() )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
OcclusionQueryHandle handle = { m_occlusionQueryHandle.alloc() };
if (isValid(handle) )
{
m_submit->m_occlusion[handle.idx] = INT32_MIN;
m_newOcclusionQueryHandle[m_numNewOcclusionQueryHandles++] = handle;
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::InvalidateOcclusionQuery);
cmdbuf.write(handle);
}
return handle;
}
BGFX_API_FUNC(OcclusionQueryResult::Enum getResult(OcclusionQueryHandle _handle, int32_t* _result) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("getResult", m_occlusionQueryHandle, _handle);
switch (m_submit->m_occlusion[_handle.idx])
{
case 0: return OcclusionQueryResult::Invisible;
case INT32_MIN: return OcclusionQueryResult::NoResult;
default: break;
}
if (NULL != _result)
{
*_result = m_submit->m_occlusion[_handle.idx];
}
return OcclusionQueryResult::Visible;
}
BGFX_API_FUNC(void destroyOcclusionQuery(OcclusionQueryHandle _handle) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE("destroyOcclusionQuery", m_occlusionQueryHandle, _handle);
m_freeOcclusionQueryHandle[m_numFreeOcclusionQueryHandles++] = _handle;
}
BGFX_API_FUNC(void requestScreenShot(FrameBufferHandle _handle, const char* _filePath) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BGFX_CHECK_HANDLE_INVALID_OK("requestScreenShot", m_frameBufferHandle, _handle);
if (isValid(_handle) )
{
const FrameBufferRef& fbr = m_frameBufferRef[_handle.idx];
if (!fbr.m_window)
{
BX_TRACE("requestScreenShot can be done only for window frame buffer handles (handle: %d).", _handle.idx);
return;
}
}
if (m_submit->m_numScreenShots >= BGFX_CONFIG_MAX_SCREENSHOTS)
{
BX_TRACE("Only %d screenshots can be requested.", BGFX_CONFIG_MAX_SCREENSHOTS);
return;
}
for (uint8_t ii = 0, num = m_submit->m_numScreenShots; ii < num; ++ii)
{
const ScreenShot& screenShot = m_submit->m_screenShot[ii];
if (screenShot.handle.idx == _handle.idx)
{
BX_TRACE("Already requested screenshot on handle %d.", _handle.idx);
return;
}
}
ScreenShot& screenShot = m_submit->m_screenShot[m_submit->m_numScreenShots++];
screenShot.handle = _handle;
screenShot.filePath.set(_filePath);
}
BGFX_API_FUNC(void setPaletteColor(uint8_t _index, const float _rgba[4]) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
BX_ASSERT(_index < BGFX_CONFIG_MAX_COLOR_PALETTE, "Color palette index out of bounds %d (max: %d)."
, _index
, BGFX_CONFIG_MAX_COLOR_PALETTE
);
bx::memCopy(&m_clearColor[_index][0], _rgba, 16);
m_colorPaletteDirty = 2;
}
BGFX_API_FUNC(void setViewName(ViewId _id, const bx::StringView& _name) )
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
View& view = m_view[_id];
if (0 == view.m_nameIdx)
{
view.m_nameIdx = m_viewNames.alloc();
}
CommandBuffer& cmdbuf = getCommandBuffer(CommandBuffer::UpdateViewName);
cmdbuf.write(view.m_nameIdx);
cmdbuf.write(_name);
}
BGFX_API_FUNC(void setViewRect(ViewId _id, int16_t _x, int16_t _y, uint16_t _width, uint16_t _height, float _minDepth = 0.0f, float _maxDepth = 1.0f) )
{
m_view[_id].setRect(_x, _y, _width, _height, _minDepth, _maxDepth);
}
BGFX_API_FUNC(void setViewScissor(ViewId _id, uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height) )
{
m_view[_id].setScissor(_x, _y, _width, _height);
}
BGFX_API_FUNC(void setViewDepthBias(ViewId _id, int32_t _constant, float _slopeScale, float _clamp) )
{
m_view[_id].setDepthBias(_constant, _slopeScale, _clamp);
}
BGFX_API_FUNC(void setViewSampleMask(ViewId _id, uint32_t _mask) )
{
m_view[_id].setSampleMask(_mask);
}
BGFX_API_FUNC(void setViewClear(ViewId _id, uint16_t _flags, uint32_t _rgba, float _depth, uint8_t _stencil) )
{
BX_ASSERT(bx::isEqual(_depth, bx::clamp(_depth, 0.0f, 1.0f), 0.0001f)
, "Clear depth value must be between 0.0 and 1.0 (_depth %f)."
, _depth
);
m_view[_id].setClear(_flags, _rgba, _depth, _stencil);
}
BGFX_API_FUNC(void setViewClear(ViewId _id, uint16_t _flags, float _depth, uint8_t _stencil, uint8_t _0, uint8_t _1, uint8_t _2, uint8_t _3, uint8_t _4, uint8_t _5, uint8_t _6, uint8_t _7) )
{
BX_ASSERT(bx::isEqual(_depth, bx::clamp(_depth, 0.0f, 1.0f), 0.0001f)
, "Clear depth value must be between 0.0 and 1.0 (_depth %f)."
, _depth
);
m_view[_id].setClear(_flags, _depth, _stencil, _0, _1, _2, _3, _4, _5, _6, _7);
}
BGFX_API_FUNC(void setViewMode(ViewId _id, ViewMode::Enum _mode) )
{
m_view[_id].m_mode = uint8_t(_mode);
}
BGFX_API_FUNC(void setViewFrameBuffer(ViewId _id, FrameBufferHandle _handle) )
{
BGFX_CHECK_HANDLE_INVALID_OK("setViewFrameBuffer", m_frameBufferHandle, _handle);
m_view[_id].setFrameBuffer(_handle);
}
BGFX_API_FUNC(void setViewTransform(ViewId _id, const void* _view, const void* _proj) )
{
m_view[_id].setTransform(_view, _proj);
}
BGFX_API_FUNC(void setViewOrder(ViewId _id, uint16_t _num, const ViewId* _order) )
{
const uint32_t num = bx::min(_id + _num, BGFX_CONFIG_MAX_VIEWS) - _id;
for (uint32_t ii = 0; ii < num; ++ii)
{
const ViewId pos = ViewId(ii+_id);
const ViewId id = NULL != _order ? _order[ii] : pos;
BX_ASSERT(id < BGFX_CONFIG_MAX_VIEWS, "Invalid view id: %d", id);
const ViewId prevPos = m_viewOrder[id];
const ViewId prevId = m_viewRemap[pos];
m_viewRemap[pos] = id;
m_viewOrder[id] = pos;
m_viewRemap[prevPos] = prevId;
m_viewOrder[prevId] = prevPos;
}
}
BGFX_API_FUNC(void setViewShadingRate(ViewId _id, ShadingRate::Enum _shadingRate) )
{
m_view[_id].setShadingRate(_shadingRate);
}
BGFX_API_FUNC(void setViewUniform(ViewId _id, UniformHandle _handle, const void* _value, uint16_t _num) )
{
m_uniformCache.setViewUniform(_id, _handle, _value, _num);
}
BGFX_API_FUNC(void resetView(ViewId _id) )
{
View* view = m_view.find(_id);
if (NULL != view)
{
if (0 != view->m_nameIdx)
{
BGFX_MUTEX_SCOPE(m_resourceApiLock);
m_viewNames.free(view->m_nameIdx);
}
view->reset();
}
m_uniformCache.invalidate(_id);
}
BGFX_API_FUNC(Encoder* begin(bool _forceNewEncoder) );
BGFX_API_FUNC(void end(Encoder* _encoder) );
BGFX_API_FUNC(uint32_t frame(uint8_t _flags = BGFX_FRAME_NONE) );
void dumpViewStats();
void freeDynamicBuffers();
void freeAllHandles(Frame* _frame);
void frameNoRenderWait();
void swap();
void collectSubmitViewUsed();
// render thread
void flip();
RenderFrame::Enum renderFrame(int32_t _msecs = -1);
void flushTextureUpdateBatch(CommandBuffer& _cmdbuf);
void rendererExecCommands(CommandBuffer& _cmdbuf);
#if BGFX_CONFIG_MULTITHREADED
void apiSemPost()
{
if (!m_singleThreaded)
{
m_apiSem.post();
}
}
bool apiSemWait(int32_t _msecs = -1)
{
if (m_singleThreaded)
{
return true;
}
BGFX_PROFILER_SCOPE("bgfx/API thread wait", kColorWait);
int64_t start = bx::getHPCounter();
bool ok = m_apiSem.wait(_msecs);
if (ok)
{
m_render->m_waitSubmit = bx::getHPCounter()-start;
m_submit->m_perfStats.waitSubmit = m_submit->m_waitSubmit;
return true;
}
return false;
}
void renderSemPost()
{
if (!m_singleThreaded)
{
m_renderSem.post();
}
}
void renderSemWait()
{
if (!m_singleThreaded)
{
BGFX_PROFILER_SCOPE("bgfx/Render thread wait", kColorWait);
int64_t start = bx::getHPCounter();
bool ok = m_renderSem.wait();
BX_ASSERT(ok, "Semaphore wait failed."); BX_UNUSED(ok);
m_submit->m_waitRender = bx::getHPCounter() - start;
m_submit->m_perfStats.waitRender = m_submit->m_waitRender;
}
}
void encoderApiWait()
{
uint16_t numEncoders = m_encoderHandle->getNumHandles();
for (uint16_t ii = 1; ii < numEncoders; ++ii)
{
m_encoderEndSem.wait();
}
uint16_t numSubmittingEncoders = 0;
uint32_t numRenderItemsRequested = 0;
for (uint16_t ii = 0; ii < numEncoders; ++ii)
{
uint16_t idx = m_encoderHandle->getHandleAt(ii);
m_encoderStats[ii].cpuTimeBegin = m_encoder[idx].m_cpuTimeBegin;
m_encoderStats[ii].cpuTimeEnd = m_encoder[idx].m_cpuTimeEnd;
numSubmittingEncoders += 0 < m_encoder[idx].m_numSubmitted;
numRenderItemsRequested += m_encoder[idx].m_numSubmitted + m_encoder[idx].m_numDropped;
}
m_submit->m_perfStats.numEncoders = uint8_t(numEncoders);
m_submit->m_needBindDedup = 1 < numSubmittingEncoders;
m_submit->m_numRenderItemsRequested = numRenderItemsRequested;
m_numDrawCallsPeak = bx::max(m_numDrawCallsPeak, numRenderItemsRequested);
collectSubmitViewUsed();
}
bx::Semaphore m_renderSem;
bx::Semaphore m_apiSem;
bx::Semaphore m_encoderEndSem;
bx::Mutex m_encoderApiLock;
bx::Mutex m_encoderBeginLock;
bx::Mutex m_resourceApiLock;
bx::Thread m_thread;
#else
void apiSemPost()
{
}
bool apiSemWait(int32_t _msecs = -1)
{
BX_UNUSED(_msecs);
return true;
}
void renderSemPost()
{
}
void renderSemWait()
{
}
void encoderApiWait()
{
m_encoderStats[0].cpuTimeBegin = m_encoder[0].m_cpuTimeBegin;
m_encoderStats[0].cpuTimeEnd = m_encoder[0].m_cpuTimeEnd;
m_submit->m_perfStats.numEncoders = 1;
m_submit->m_needBindDedup = false;
m_submit->m_numRenderItemsRequested = m_encoder[0].m_numSubmitted + m_encoder[0].m_numDropped;
m_numDrawCallsPeak = bx::max(m_numDrawCallsPeak, m_submit->m_numRenderItemsRequested);
collectSubmitViewUsed();
}
#endif // BGFX_CONFIG_MULTITHREADED
EncoderStats* m_encoderStats;
Encoder* m_encoder0;
EncoderImpl* m_encoder;
uint32_t m_numEncoders;
bx::HandleAlloc* m_encoderHandle;
Frame m_frame[1+(BGFX_CONFIG_MULTITHREADED ? 1 : 0)];
Frame* m_render;
Frame* m_submit;
uint64_t* m_tempKeys;
RenderItemCount* m_tempValues;
uint32_t m_tempCapacity;
uint32_t m_numDrawCallsPeak;
typedef stl::unordered_map<uint32_t, uint32_t> BindHashMap;
BindHashMap m_renderBindHashMap;
HandleArenaT<IndexBuffer, BGFX_CONFIG_MAX_INDEX_BUFFERS> m_indexBuffers;
HandleArenaT<VertexBuffer, BGFX_CONFIG_MAX_VERTEX_BUFFERS> m_vertexBuffers;
HandleArenaT<DynamicIndexBuffer, BGFX_CONFIG_MAX_DYNAMIC_INDEX_BUFFERS> m_dynamicIndexBuffers;
HandleArenaT<DynamicVertexBuffer, BGFX_CONFIG_MAX_DYNAMIC_VERTEX_BUFFERS> m_dynamicVertexBuffers;
uint16_t m_numFreeOcclusionQueryHandles;
uint16_t m_numNewOcclusionQueryHandles;
FreeHandle<DynamicIndexBufferHandle, BGFX_CONFIG_MAX_DYNAMIC_INDEX_BUFFERS> m_freeDynamicIndexBuffer;
FreeHandle<DynamicVertexBufferHandle, BGFX_CONFIG_MAX_DYNAMIC_VERTEX_BUFFERS> m_freeDynamicVertexBuffer;
OcclusionQueryHandle m_freeOcclusionQueryHandle[BGFX_CONFIG_MAX_OCCLUSION_QUERIES];
OcclusionQueryHandle m_newOcclusionQueryHandle[BGFX_CONFIG_MAX_OCCLUSION_QUERIES];
NonLocalAllocator m_dynIndexBufferAllocator;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_DYNAMIC_INDEX_BUFFERS> m_dynamicIndexBufferHandle;
NonLocalAllocator m_dynVertexBufferAllocator;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_DYNAMIC_VERTEX_BUFFERS> m_dynamicVertexBufferHandle;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_INDEX_BUFFERS> m_indexBufferHandle;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_VERTEX_LAYOUTS > m_layoutHandle;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_VERTEX_BUFFERS> m_vertexBufferHandle;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_SHADERS> m_shaderHandle;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_PROGRAMS> m_programHandle;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_TEXTURES> m_textureHandle;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_FRAME_BUFFERS> m_frameBufferHandle;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_UNIFORMS> m_uniformHandle;
bx::HandleAlloc2T<BGFX_CONFIG_MAX_OCCLUSION_QUERIES> m_occlusionQueryHandle;
typedef bx::HandleHashMapT<BGFX_CONFIG_MAX_UNIFORMS*2> UniformHashMap;
UniformHashMap m_uniformHashMap;
HandleArenaT<UniformRef, BGFX_CONFIG_MAX_UNIFORMS> m_uniformRef;
typedef bx::HandleHashMapT<BGFX_CONFIG_MAX_SHADERS*2> ShaderHashMap;
ShaderHashMap m_shaderHashMap;
HandleArenaT<ShaderRef, BGFX_CONFIG_MAX_SHADERS> m_shaderRef;
typedef bx::HandleHashMapT<BGFX_CONFIG_MAX_PROGRAMS*2> ProgramHashMap;
ProgramHashMap m_programHashMap;
ProgramRef m_programRef[BGFX_CONFIG_MAX_PROGRAMS];
HandleArenaT<TextureRef, BGFX_CONFIG_MAX_TEXTURES> m_textureRef;
HandleArenaT<FrameBufferRef, BGFX_CONFIG_MAX_FRAME_BUFFERS> m_frameBufferRef;
VertexLayoutRef m_vertexLayoutRef;
ViewId m_viewRemap[BGFX_CONFIG_MAX_VIEWS];
ViewId m_viewOrder[BGFX_CONFIG_MAX_VIEWS];
ViewArena m_view;
ViewNameArena m_viewNames;
uint32_t m_viewObserve;
UniformCache m_uniformCache;
float m_clearColor[BGFX_CONFIG_MAX_COLOR_PALETTE][4];
uint8_t m_colorPaletteDirty;
Init m_init;
int64_t m_frameTimeLast;
uint32_t m_frames;
uint32_t m_debug;
FrameBufferHandle m_debugFrameBuffer;
uint8_t m_debugTextScale;
int64_t m_rtMemoryUsed;
int64_t m_textureMemoryUsed;
TextVideoMemBlitter m_textVideoMemBlitter;
ClearQuad m_clearQuad;
MipGen m_mipGen;
BlitFallback m_blitFallback;
VideoDecode m_videoDecode;
RendererContextI* m_renderCtx;
bool m_headless;
bool m_rendererInitialized;
bool m_exit;
bool m_flipAfterRender;
bool m_singleThreaded;
bool m_flipped;
bool m_flushPrevFrame;
typedef UpdateBatchT<256> TextureUpdateBatch;
BX_ALIGN_DECL_CACHE_LINE(TextureUpdateBatch m_textureUpdateBatch);
};
#undef BGFX_API_FUNC
} // namespace bgfx
#endif // BGFX_P_H_HEADER_GUARD