|
| template<typename T > |
| span< T > | kanzi::gfx::allocateCommandBufferCommands (const CommandBufferHandleGuard &handle, uint32_t count) |
| | Allocates typed command buffer memory.
|
| |
| KANZI_GFX_API span< byte > | kanzi::gfx::allocateCommandBufferMemory (const CommandBufferHandleGuard &handle, uint32_t size) |
| | Allocates raw memory into a command buffer.
|
| |
| constexpr v2u32 | kanzi::gfx::calculateDimensionsForMip (v2u32 dims, uint8_t mip) |
| | Calculates the dimensions of a 2-dimensional mip level.
|
| |
| constexpr v3u32 | kanzi::gfx::calculateDimensionsForMip (v3u32 dims, uint8_t mip) |
| | Calculates the dimensions of a 3-dimensional mip level.
|
| |
| KANZI_GFX_API void | kanzi::gfx::cleanupThread () |
| | Cleans up per-thread resources.
|
| |
| KANZI_GFX_API HandleGuard< BlendStateHandle > | kanzi::gfx::create (const BlendStateCreateInfo &info) |
| | Creates a blend state graphics object.
|
| |
| KANZI_GFX_API HandleGuard< BottomLevelAccelerationStructureHandle > | kanzi::gfx::create (const BottomLevelAccelerationStructureCreateInfo &info) |
| | Creates a bottom level acceleration structure graphics object.
|
| |
| KANZI_GFX_API HandleGuard< BufferHandle > | kanzi::gfx::create (const BufferCreateInfo &info) |
| | Creates a buffer graphics object.
|
| |
| KANZI_GFX_API HandleGuard< CommandBufferHandle > | kanzi::gfx::create (const CommandBufferCreateInfo &info) |
| | Creates a command buffer graphics object.
|
| |
| KANZI_GFX_API HandleGuard< ComputePipelineHandle > | kanzi::gfx::create (const ComputePipelineCreateInfo &info) |
| | Creates a compute pipeline graphics object.
|
| |
| KANZI_GFX_API HandleGuard< ComputeResourceSetHandle > | kanzi::gfx::create (const ComputeResourceSetCreateInfo &info) |
| | Creates a compute resource set graphics object.
|
| |
| KANZI_GFX_API HandleGuard< DepthStencilStateHandle > | kanzi::gfx::create (const DepthStencilStateCreateInfo &info) |
| | Creates a depth stencil state graphics object.
|
| |
| KANZI_GFX_API HandleGuard< FrameBufferHandle > | kanzi::gfx::create (const FrameBufferCreateInfo &info) |
| | Creates a frame buffer graphics object.
|
| |
| KANZI_GFX_API HandleGuard< GpuFenceHandle > | kanzi::gfx::create (const GpuFenceCreateInfo &info) |
| | Creates a GPU fence graphics object.
|
| |
| KANZI_GFX_API HandleGuard< GPUSceneHandle > | kanzi::gfx::create (const GPUSceneCreateInfo &info) |
| | Creates a GPU scene object.
|
| |
| KANZI_GFX_API HandleGuard< ImageHandle > | kanzi::gfx::create (const ImageCreateInfo &info) |
| | Creates an image graphics object.
|
| |
| KANZI_GFX_API HandleGuard< QueryPoolHandle > | kanzi::gfx::create (const QueryPoolCreateInfo &info) |
| | Creates a GPU query pool graphics object.
|
| |
| KANZI_GFX_API HandleGuard< RasterStateHandle > | kanzi::gfx::create (const RasterStateCreateInfo &info) |
| | Creates a raster state graphics object.
|
| |
| KANZI_GFX_API HandleGuard< RenderPassHandle > | kanzi::gfx::create (const RenderPassCreateInfo &info) |
| | Creates a render pass graphics object.
|
| |
| KANZI_GFX_API HandleGuard< RenderPipelineHandle > | kanzi::gfx::create (const RenderPipelineCreateInfo &info) |
| | Creates a render pipeline graphics object.
|
| |
| KANZI_GFX_API HandleGuard< RenderResourceSetHandle > | kanzi::gfx::create (const RenderResourceSetCreateInfo &info) |
| | Creates a render resource set graphics object.
|
| |
| KANZI_GFX_API HandleGuard< SamplerHandle > | kanzi::gfx::create (const SamplerCreateInfo &info) |
| | Creates a sampler graphics object.
|
| |
| KANZI_GFX_API HandleGuard< ShaderHandle > | kanzi::gfx::create (const ShaderCreateInfo &info) |
| | Creates a shader graphics object.
|
| |
| KANZI_GFX_API HandleGuard< TopLevelAccelerationStructureHandle > | kanzi::gfx::create (const TopLevelAccelerationStructureCreateInfo &info) |
| | Creates a top level acceleration structure graphics object.
|
| |
| KANZI_GFX_API HandleGuard< VertexInputStateHandle > | kanzi::gfx::create (const VertexInputStateCreateInfo &info) |
| | Creates a vertex input state graphics object.
|
| |
| KANZI_GFX_API ChannelType | kanzi::gfx::formatToChannelType (Format format) |
| | Gets the channel encoding type for a graphics format.
|
| |
| KANZI_GFX_API BackendInformation | kanzi::gfx::getBackendInformation () |
| | Gets information about the current backend.
|
| |
| KANZI_GFX_API v2u8 | kanzi::gfx::getBlockSize (Format format) |
| | Gets the block size in pixels of a compressed format.
|
| |
| KANZI_GFX_API uint32_t | kanzi::gfx::getBlockStride (Format format) |
| | Gets the block stride in bytes for a compressed graphics format.
|
| |
| KANZI_GFX_API uint32_t | kanzi::gfx::getChannelCount (Format format) |
| | Gets the number of color and alpha channels in a graphics format.
|
| |
| KANZI_GFX_API v4u8 | kanzi::gfx::getColorBits (Format format) |
| | Gets the number of bits used to represent each color and alpha channel.
|
| |
| KANZI_GFX_API v2u8 | kanzi::gfx::getDepthStencilBits (Format format) |
| | Gets the number of bits used to represent each depth and stencil channel.
|
| |
| KANZI_GFX_API uint64_t | kanzi::gfx::getDeviceAddress (const BufferHandleGuard &handle) |
| | Gets the GPU virtual address of a buffer for use with shader buffer device address (BDA).
|
| |
| KANZI_GFX_API uint32_t | kanzi::gfx::getDeviceProperty (DevicePropertyId property) |
| | Gets the value of a property for the current device.
|
| |
| uint8_t | kanzi::gfx::getFaceCount (gfx::ImageType type) |
| | Gets the face count for a given resource type.
|
| |
| KANZI_GFX_API AspectMask | kanzi::gfx::getFormatAspects (Format format) |
| | Gets the aspect mask for a given graphics format.
|
| |
| KANZI_GFX_API FormatFeatureFlag | kanzi::gfx::getFormatFeatures (Format format) |
| | Gets device feature flags for a format for the current backend and device.
|
| |
| KANZI_GFX_API AttachmentDescriptionSet | kanzi::gfx::getFrameBufferAttachmentDescriptionSet (const FrameBufferHandleGuard &handle) |
| | Gets a default frame buffer attachment description set that is compatible with a frame buffer.
|
| |
| KANZI_GFX_API size_t | kanzi::gfx::getImageSize (Format format, v3u32 dimensions) |
| | Gets the size in bytes of an image with the specified format and dimensions.
|
| |
| uint32_t | kanzi::gfx::getIndexBufferStride (IndexBufferType type) |
| | Gets the stride in bytes of an index buffer type.
|
| |
| KANZI_GFX_API uint32_t | kanzi::gfx::getPixelStride (Format format) |
| | Gets the pixel stride in bytes for an uncompressed graphics format.
|
| |
| constexpr ShaderFormatFamily | kanzi::gfx::getShaderFormatFamily (ShaderFormat format) |
| | Gets the Shader format family for a given shader format.
|
| |
| KANZI_GFX_API ObjectStatus | kanzi::gfx::getStatus (const RenderPipelineHandleGuard &handle) |
| | Gets the status of a render pipeline graphics object.
|
| |
| KANZI_GFX_API ObjectStatus | kanzi::gfx::getStatus (const ShaderHandleGuard &handle) |
| | Gets the status of a shader graphics object.
|
| |
| KANZI_GFX_API platform::SurfaceBits | kanzi::gfx::getSurfaceBitsFromFormat (Format color, Format depthStencil=Format::None) |
| | Converts a color and depth stencil Format into a SurfaceBits structure.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::initialize (const InitializationInfo &info) |
| | Initializes the Kanzi graphics library.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isAlpha (Format format) |
| | Returns whether a graphics format contains an alpha channel.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isAstcHdrCompressed (Format format) |
| | Returns whether a graphics format is ASTC HDR compressed.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isColor (Format format) |
| | Returns whether a graphics format contains a color channel.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isCompressed (Format format) |
| | Returns whether a graphics format is compressed.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isDepth (Format format) |
| | Returns whether a graphics format contains a depth channel.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isFeatureEnabled (FeatureId feature) |
| | Returns whether a graphics feature is supported by the current backend and device.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isInitialized () |
| | Returns whether the graphics library is initialized.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isNativeTextureHandleTypeSupported (const gfx::NativeTextureHandle &handle) |
| | Returns whether a native handle type for texture is supported by the current backend.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isShaderFormatSupported (ShaderFormat format) |
| | Returns whether a shader format is supported by the current backend and device.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isSRGBEncoded (Format format) |
| | Returns whether the color channels of a graphics format are sRGB-encoded.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::isStencil (Format format) |
| | Returns whether a graphics format contains a stencil channel.
|
| |
| KANZI_GFX_API span< byte > | kanzi::gfx::mapBuffer (const BufferHandleGuard &handle, uint32_t offset=0, uint32_t size=limits::MaxBufferSize) |
| | Maps buffer memory into CPU-addressable memory for reading or writing.
|
| |
| KANZI_GFX_API string | kanzi::gfx::outputCommandBuffer (DebugInformation &debugInformation, const CommandBufferHandleGuard &commandBuffer) |
| | Outputs the contents of a command buffer into a string.
|
| |
| KANZI_GFX_API span< const byte > | kanzi::gfx::peekCommandBufferMemory (const CommandBufferHandleGuard &handle) |
| | Peeks at the currently allocated memory inside a command buffer.
|
| |
| KANZI_GFX_API void | kanzi::gfx::processCommands (CommandBufferHandleGuard commands, TaskFn callback={}) |
| | Notifies the backend to start processing the commands within a command buffer.
|
| |
| KANZI_GFX_API bool | kanzi::gfx::readQueryResults (QueryPoolHandleGuard handle, uint32_t first, span< uint64_t > results) |
| | Reads query results from a pool.
|
| |
| KANZI_GFX_API void | kanzi::gfx::resetGpuFence (const GpuFenceHandleGuard &handle) |
| | Resets the state of a GPU fence so that it can be used again.
|
| |
| KANZI_GFX_API void | kanzi::gfx::shutdown () |
| | Shuts down the graphics library.
|
| |
| KANZI_GFX_API FixedString | kanzi::gfx::toFixedString (FilterMode filter) |
| | Gets a string representation of a filter mode.
|
| |
| KANZI_GFX_API string | kanzi::gfx::toString (ColorWriteMask writeMask) |
| | Gets the color write mask as a string.
|
| |
| KANZI_GFX_API string | kanzi::gfx::toString (DevicePropertyId propertyId) |
| | Gets the device property identifier as a string.
|
| |
| KANZI_GFX_API string | kanzi::gfx::toString (FeatureId feature) |
| | Gets the Feature identifier as a string.
|
| |
| KANZI_GFX_API string | kanzi::gfx::toString (Format fmt) |
| |
| KANZI_GFX_API string | kanzi::gfx::toString (FormatFeatureFlag flags) |
| |
| KANZI_GFX_API string | kanzi::gfx::toString (NativeTextureHandleType type) |
| |
| KANZI_GFX_API string | kanzi::gfx::toString (ShaderFormat format) |
| | Gets the shader format as a string.
|
| |
| KANZI_GFX_API string | kanzi::gfx::toString (ShaderStage stage) |
| | Gets the shader stage as a string.
|
| |
| Format | kanzi::gfx::tryGetDepthStencilFromSurfaceBits (const platform::SurfaceBits &properties) |
| | Matches a SurfaceBits structure to a depth stencil graphics format.
|
| |
| Format | kanzi::gfx::tryGetFormatFromSurfaceBits (const platform::SurfaceBits &properties) |
| | Matches a SurfaceBits structure to a graphics format.
|
| |
| KANZI_GFX_API void | kanzi::gfx::unmapBuffer (const BufferHandleGuard &handle) |
| | Unmaps buffer memory from CPU-addressable memory.
|
| |
| KANZI_GFX_API void | kanzi::gfx::unmapBuffer (const BufferHandleGuard &handle, span< ByteRange > updatedRanges) |
| | Unmaps buffer memory from CPU-addressable memory.
|
| |
| KANZI_GFX_API void | kanzi::gfx::updateSurfaceDimensions (const FrameBufferHandleGuard &handle, v2u32 dimensions) |
| | Updates the dimensions for a frame buffer that was created as an on-screen surface.
|
| |
| template<typename T_Func > |
| void | kanzi::gfx::visitCommands (const span< const byte > &commandMemory, T_Func &&func) |
| | Traverses the command memory.
|
| |
| KANZI_GFX_API WaitResult | kanzi::gfx::waitForGpuFence (const GpuFenceHandleGuard &handle, chrono::nanoseconds timeout) |
| | Blocks the current thread until the GPU fence has been signaled or the timeout occurs.
|
| |
The functions of the graphics libraries.