The vireo RHI module — low-level GPU resource creation and command recording.

Enums & Constants
enum	AddressMode
	Texture coordinate wrapping mode applied when UV coordinates fall outside [0, 1].

enum	AttributeFormat
	Vertex attribute data format constants used in VertexInputLayout descriptions.

enum	Backend
	Rendering backend identifier.

enum	BlendFactor
	Source or destination multiplier constants for color blending equations.

enum	BlendOp
	Arithmetic operation combining the source and destination terms in a blend equation.

enum	BufferType
	Constants specifying the intended GPU usage of a Buffer.

enum	ColorWriteMask
	Bitmask controlling which color channels are written by a pipeline.

enum	CommandType
	Queue and command-allocator type constants.

enum	CompareOp
	Depth, stencil, and sampler comparison operators.

enum	CullMode
	Polygon face-culling mode.

enum	DescriptorType
	Binding type constants for DescriptorLayout entries.

enum	Filter
	Texture filtering mode for min/mag sampling.

enum	FilterMode
	Mip-map selection mode.

enum	ImageFormat
	Pixel format constants for images, render targets, and swap chains.

enum	IndexType
	Data type of index elements in an index buffer.

enum	LogicOp
	Bitwise logical operation applied to color attachment values (enabled via logic_op_enable).

enum	MSAA
	Multisampling anti-aliasing sample-count constants.

enum	PipelineType
	Pipeline kind constants.

enum	PolygonMode
	Rasterization fill mode for polygons.

enum	PresentMode
	Swap-chain frame presentation mode.

enum	PrimitiveTopology
	Input assembly topology — defines how vertices are grouped into primitives.

enum	RenderTargetType
	Attachment type for render targets.

enum	ResourceState
	Resource state constants used in pipeline barriers to declare how a resource is accessed.

enum	SemaphoreType
	GPU synchronization semaphore type.

enum	ShaderStage
	Bitmask constants identifying one or more shader stages in a pipeline.

enum	StencilOp
	Operations applied to a stencil buffer value based on test results.

enum	WaitStage
	Pipeline stage constants used in semaphore wait/signal operations and barrier scopes.

Structures
struct	BufferCopyRegion
	Describes a single source/destination region pair for a buffer-to-buffer copy operation.

struct	ClearValue
	Union holding either a color clear value (r/g/b/a) or a depth/stencil clear value (depth/stencil). Set r/g/b/a for color attachments; set depth/stencil for depth attachments.

struct	ColorBlendDesc
	Color blend state for a single render-target color attachment.

struct	DepthClearValue
	Depth and stencil values used when clearing a depth/stencil attachment.

struct	Device
	The logical device wrapping the selected GPU. Retrieved via Vireo.device.

struct	DrawIndexedIndirectCommand
	GPU-side structure for an indirect indexed draw call. Mirror of VkDrawIndexedIndirectCommand / D3D12_DRAW_INDEXED_ARGUMENTS.

struct	DrawIndirectCommand
	GPU-side structure for an indirect (non-indexed) draw call. Mirror of VkDrawIndirectCommand / D3D12_DRAW_ARGUMENTS.

struct	Extent
	2-D integer dimensions in pixels or texels.

struct	GraphicPipelineConfiguration
	Full description of a graphics pipeline passed to Vireo.create_graphic_pipeline().

struct	PhysicalDevice
	Represents the physical GPU selected by the engine. Retrieved via Vireo.physical_device.

struct	PhysicalDeviceDesc
	GPU device description returned by PhysicalDevice.description.

struct	Pipeline
	Base type for compiled GPU pipelines. Use vireo.ComputePipeline or vireo.GraphicPipeline.

struct	PushConstantsDesc
	Describes a push-constant range visible to one or more shader stages.

struct	Rect
	2-D integer rectangle (pixel position + size). Constructor: Rect(width, height) sets x=y=0; Rect(x, y, width, height).

struct	RenderingConfiguration
	Full render-pass configuration passed to CommandList.begin_rendering().

struct	RenderTarget
	A render-target image wrapper. Created by Vireo.create_render_target() or Vireo.create_render_target_from_swap_chain().

struct	RenderTargetDesc
	Describes a single attachment slot in a RenderingConfiguration.

struct	StencilOpState
	Per-face stencil test and write operations.

struct	VertexAttributeDesc
	Describes a single vertex attribute within a VertexInputLayout.

struct	VideoMemoryAllocationDesc
	Describes a single GPU memory allocation reported by Buffer.get_memory_allocations() or Image.get_memory_allocations().

struct	Viewport
	Floating-point viewport with depth range. Constructor: Viewport(width, height); Viewport(x, y, width, height).

Classes
class	Buffer
	A GPU buffer allocation. Created by Vireo.create_buffer().

class	CommandAllocator
	Manages a pool of command lists for a specific queue type. Created by Vireo.create_command_allocator().

class	CommandList
	Records a sequence of GPU commands for later submission. Obtained from CommandAllocator.create_command_list().

class	ComputePipeline
	A compiled compute pipeline binding a single compute shader. Created by Vireo.create_compute_pipeline().

class	DescriptorLayout
	Describes the binding slots of a descriptor set. Created by Vireo.create_descriptor_layout(). Must be built with build() before creating descriptor sets.

class	DescriptorSet
	A bound collection of resources (buffers, images, samplers) for a pipeline. Created by Vireo.create_descriptor_set().

class	Fence
	CPU/GPU synchronization primitive. Created by Vireo.create_fence(). Signaled by the GPU after a submit; waited on by the CPU.

class	GraphicPipeline
	A compiled graphics pipeline with full rasterization state. Created by Vireo.create_graphic_pipeline().

class	Image
	A GPU image (texture or render attachment). Created by Vireo.create_image() or Vireo.create_read_write_image().

class	Instance
	The underlying API instance (VkInstance / IDXGIFactory). Retrieved via Vireo.instance. Opaque; used for platform-specific window surface creation.

class	PipelineResources
	The pipeline layout — describes which descriptor sets and push constants a pipeline uses. Created by Vireo.create_pipeline_resources(). Opaque.

class	Sampler
	Immutable texture sampler state object. Created by Vireo.create_sampler(). Opaque; bind it to descriptor sets via DescriptorSet.update_sampler().

class	Semaphore
	GPU/GPU or GPU/CPU synchronization primitive. Created by Vireo.create_semaphore().

class	ShaderModule
	A compiled shader binary. Created by Vireo.create_shader_module_from_file() or Vireo.create_shader_module_from_data(). Opaque; pass to GraphicPipelineConfiguration or Vireo.create_compute_pipeline().

class	SubmitQueue
	GPU command submission queue. Created by Vireo.create_submit_queue().

class	SwapChain
	Presentation swap chain managing a set of back buffers for a window. Created by Vireo.create_swap_chain().

class	VertexInputLayout
	Describes vertex buffer bindings and per-attribute formats for a graphics pipeline. Created by Vireo.create_vertex_layout(). Opaque; pass to GraphicPipelineConfiguration.vertex_input_layout.

class	Vireo
	Main RHI entry point. Obtained from the host application; not constructed in Lua.

Enums & Constants

Structures

Classes