Creates a new Vireo class using the given backend.

Creates a data buffer in VRAM. For types UNIFORM & TRANSFER the buffer will be created in host visible memory/upload heap type. For types VERTEX & INDEX the buffer will be created in device local memory/default heap type

Parameters

type	Type of buffer to create.
size	Size of one element in bytes
count	Number of elements
name	Object name for debug

Creates a command allocator (command pool) for a given command type

Parameters

type	Type of commands that will be used with command lists created from this allocator

Creates a compute pipeline

Parameters

pipelineResources	Resources for the shader
shader	The shader
name	Object name for debug

Creates an empty description layout.

Parameters

name	Object name for debug

Creates an empty descriptor set

Parameters

layout	Layout of the set
name	Object name for debug

Creates an empty description layout for UNIFORM_DYNAMIX resources types

Parameters

name	Object name for debug

Creates a fence for CPU/GPU synchronization

Parameters

createSignaled	Create the fence in signaled state
name	Object name for debug

Creates a graphic pipeline. At least one shader must be used.

Parameters

configuration	Pipeline configuration
name	Object name for debug

Creates a read-only image in VRAM

Parameters

format	Pixel format
width	With in pixels
height	Height in pixels
mipLevels	Number of mips levels
arraySize	Number of layers/array size
name	Object name for debug

Creates a pipeline resources description. Describe resources that can be accessed by the shaders associated with the future pipelines.

Parameters

descriptorLayouts	Descriptions of the resources (can be empty)
pushConstant	Description of an optional push constant
name	Object name for debug

Creates a read/write image in VRAM

Parameters

format	Pixel format
width	With in pixels
height	Height in pixels
mipLevels	Number of mips levels
arraySize	Number of layers/array size
name	Object name for debug

Creates a read/write image in VRAM for use as a render target with a similar format as a swap chain.

Parameters

swapChain	Swap chain to copy format & size from
clearValue	A clear value used for optimized clearing. Must be the same as the clear value used when rendering.
msaa	Number of samples for MSAA. A value of 1 disables MSAA.
name	Object name for debug

Creates a read/write image in VRAM for use as a render target

Parameters

format	Pixel format
width	With in pixels
height	Height in pixels
type	Type of render target use
clearValue	A clear value used for optimized clearing. Must be the same as the clear value used when rendering.
msaa	Number of samples for MSAA. A value of 1 disables MSAA.
name	Object name for debug

Creates a texture sampler.

Creates an empty description layout for SAMPLER resources types

Parameters

name	Object name for debug

Creates a semaphore for GPU/GPU synchronization

Parameters

type	Semaphore type
name	Object name for debug

Load a compiled shader and creates a shader module

Parameters

fileName

File name without the extension. The file name extension must be .spvfor Vulkan et .dxil for DirectX

Load a compiled shader and creates a shader module from an input stream

Creates a shader module

Creates a submission queue

Parameters

commandType	Type of commands that will be used with this queue.
name	Objet name for debug

Creates a swap chain.

Parameters

format	Color format of the swap chain images
presentQueue	Queue used to present the swap chain images in the window surface
presentMode	Presentation mode
windowHandle	Opaque window handle to present the swap chain images
framesInFlight	Number of concurrent swap chain images

Creates an input vertex layout from a description

Parameters

size	Size in bytes of a vertex
attributesDescriptions	Description of all the vertex attributes

Returns the physical device/adapter object

Returns true if the backend API is supported