RHI

Render Hardware Interface (RHI) module provides uniform API to use platform's graphcis hardware (GPU) to accelerate rendering and parallel computing tasks.

Topics

• RHI Errors

Types

• Luna::RHI::IAdapter

  Represents a physical graphics device installed on the platform.

• Luna::RHI::BufferDesc

  Describes one IBuffer object.

• Luna::RHI::IBuffer

  Represents one buffer resource that can be used to contain arbitrary binary data.

• Luna::RHI::TextureBarrier

  Describes one texture barrier.

• Luna::RHI::BufferBarrier

  Describes one buffer barrier.

• Luna::RHI::Viewport

  Describes one viewport used by ICommandBuffer::set_viewport and ICommandBuffer::set_viewports.

• Luna::RHI::ColorAttachment

  Describes one color attachment when beginning a render pass.

• Luna::RHI::DepthStencilAttachment

  Describes one depth stencil attachment when beginning a render pass.

• Luna::RHI::ResolveAttachment

  Describes one resolve attachment when beginning a render pass.

• Luna::RHI::RenderPassDesc

  Describes one render pass.

• Luna::RHI::ComputePassDesc

  Describes one compute pass.

• Luna::RHI::CopyPassDesc

  Describes one copy pass.

• Luna::RHI::VertexBufferView

  Describes one vertex buffer view when binding one vertex buffer to the render pipeline.

• Luna::RHI::IndexBufferView

  Describes one index buffer view when binding one index buffer to the render pipeline.

• Luna::RHI::ICommandBuffer

  Used to allocate memory for commands, record commands, submitting commands to GPU and tracks the state of the submitted commands.

• Luna::RHI::BufferViewDesc

  Describes one buffer view in descriptor set.

• Luna::RHI::TextureViewDesc

  Describes one texture view in descriptor set.

• Luna::RHI::SamplerDesc

  Describes one sampler in descriptor set.

• Luna::RHI::DescriptorSetDesc

  Describes one descriptor set.

• Luna::RHI::WriteDescriptorSet

  Describes one descriptor set write operation. Every descriptor set write operation may update one continuous range of descriptors in the same binding slot.

• Luna::RHI::IDescriptorSet

  Describes which views and samples are bound to the pipeline. This can be set at any time before the draw call or dispatch call is submitted.

• Luna::RHI::DescriptorSetLayoutBinding

  Describes one binding in one descriptor set.

• Luna::RHI::DescriptorSetLayoutDesc

  Specifies one descriptor set layout.

• Luna::RHI::IDescriptorSetLayout

  Represents one descriptor set layout that can be used to create descriptor sets and pipeline layouts.

• Luna::RHI::DeviceFeatureData

  Represents the device feature check result.

• Luna::RHI::CommandQueueDesc

  Describes one command queue.

• Luna::RHI::IDevice

  Represents one logical graphic device on the platform.

• Luna::RHI::IDeviceChild

  Represents one object that is created by IDevice and is only available in the device context.

• Luna::RHI::IDeviceMemory

  Represents one allocated device memory.

• Luna::RHI::IFence

  Represents a synchronization object that can be used to synchronize commands executed in different command queues.

• Luna::RHI::PipelineLayoutDesc

  Describes one pipeline layout.

• Luna::RHI::IPipelineLayout

  Describes how shader parameters are accessed by every shader in the pipeline.

• Luna::RHI::ShaderData

  Specify one shader data.

• Luna::RHI::ComputePipelineStateDesc

  Describes pipeline configurations of one compute pipeline.

• Luna::RHI::InputAttributeDesc

  Describes one attribute in the input layout.

• Luna::RHI::InputBindingDesc

  Describes one input buffer binding.

• Luna::RHI::InputLayoutDesc

  Describes the vertex input layout for the graphics pipeline.

• Luna::RHI::AttachmentBlendDesc

  Describes the blending configurations for one attachment.

• Luna::RHI::BlendDesc

  Describes blending configurations for one graphics pipeline.

• Luna::RHI::RasterizerDesc

  Describes rasterizer configurations for one graphics pipeline.

• Luna::RHI::DepthStencilOpDesc

  Describes the depth stencil operation.

• Luna::RHI::DepthStencilDesc

  Describes depth stencil stage configurations of one graphics pipeline.

• Luna::RHI::GraphicsPipelineStateDesc

  Describes pipeline configurations of one compute pipeline.

• Luna::RHI::IPipelineState

  Represents one pipeline state object that stores pipeline configurations that can be applied to one pipeline in one call.

• Luna::RHI::PipelineStatistics

  Specifies one query in pipeline statistics query heap.

• Luna::RHI::QueryHeapDesc

  Describes one query heap.

• Luna::RHI::IQueryHeap

  Contains one array of query elements that can be used to query pipeline execution information, such as pixel occlusion, execution time and pipeline statistics.

• Luna::RHI::SubresourceIndex

  Specifies the index pair of one subresource in one texture resource.

• Luna::RHI::IResource

  Represents a memory region that can be accessed by GPU.

• Luna::RHI::SwapChainDesc

  Describes one swap chain.

• Luna::RHI::ISwapChain

  Represents one swap chain used for presenting images to the screen.

• Luna::RHI::TextureDesc

  Describes one texture resource.

• Luna::RHI::DepthStencilValue

  Describes one pair of depth and stencil values used for clearing depth stencil attachments.

• Luna::RHI::ClearValue

  Describes one clear value used to specify optimized clear value for texture resources.

• Luna::RHI::ITexture

  Represents one texture resource that can be used to contain pixel data of certain format.

• Luna::RHI::CopyResourceData

  Specifies one resource data copy operation.

Enumerations

• Luna::RHI::BufferUsageFlag

  Specifies possible usages for one IBuffer object.

• Luna::RHI::ResourceBarrierFlag

  Specifies additional flags for one buffer or texture barrier.

• Luna::RHI::BufferStateFlag

  Specifies buffer resource states before and after one barrier.

• Luna::RHI::TextureStateFlag

  Specifies texture resource states before and after one barrier.

• Luna::RHI::LoadOp

  The operation to perform when the attachment is loaded to GPU.

• Luna::RHI::StoreOp

  The operation to perform when the render texture is written back to resource memory.

• Luna::RHI::OcclusionQueryMode

  Specifies the occlusion query working mode.

• Luna::RHI::Filter

  Specifies the filtering mode for samplers.

• Luna::RHI::TextureAddressMode

  Specifies the texture address mode for samplers when the sample position does not fall in range [0, 1].

• Luna::RHI::BorderColor

  Specifies the border color to use if texture address mode is TextureAddressMode::border.

• Luna::RHI::DescriptorType

  Specifies the type of descriptors that can be placed in a descriptor set.

• Luna::RHI::TextureViewType

  Specifies the texture view type, which is how render pipeline interprets texture data.

• Luna::RHI::ShaderVisibilityFlag

  Specifies which shader can access descriptors in the specified binding.

• Luna::RHI::DescriptorSetLayoutFlag

  Specifies additional flags for one descriptor set layout.

• Luna::RHI::DeviceFeature

  Specifies device features that can be queried at run time.

• Luna::RHI::CommandQueueType

  Specifies command queue types.

• Luna::RHI::CommandQueueFlag

  Specifies additional flags for command queues.

• Luna::RHI::MemoryType

  Specify the memory type. See remarks for details.

• Luna::RHI::PipelineLayoutFlag

  Describes attributes of one pipeline layout object.

• Luna::RHI::ShaderDataFormat

  Specify shader data format.

• Luna::RHI::InputRate

  The input rate for one input attribute (per vertex or per instance).

• Luna::RHI::BlendFactor

  Specifies the blend factor used for blending.

• Luna::RHI::BlendOp

  Specifies the blend operation.

• Luna::RHI::ColorWriteMask

  Identifies which components of each pixel of a attachment are writable during blending.

• Luna::RHI::FillMode

  Describes triangle fill mode of the rasterizer.

• Luna::RHI::CullMode

  Describes cull mode of the rasterizer.

• Luna::RHI::StencilOp

  Specifies the stencil operation to perform when stencil test passed or failed.

• Luna::RHI::CompareFunction

  Specifies the compare function used for comparison.

• Luna::RHI::IndexBufferStripCutValue

  The value used to finish an existing line or triangle strip and start a new one when GraphicsPipelineStateDesc::primitive_topology is set to PrimitiveTopology::line_strip or PrimitiveTopology::triangle_strip.

• Luna::RHI::PrimitiveTopology

  Specifies the primitive type for the graphics pipeline to draw.

• Luna::RHI::QueryType

  Specifies query type.

• Luna::RHI::ResourceFlag

  Specifies additional flags for one resource.

• Luna::RHI::BackendType

  Lists supported RHI backends (implementation APIs).

• Luna::RHI::Format

  Describes data formats for vertices and pixels in RHI.

• Luna::RHI::TextureType

  Specifies the texture type.

• Luna::RHI::TextureUsageFlag

  Specifies possible usages of one texture resource.

• Luna::RHI::ClearValueType

  Specifies the clear value type used.

• Luna::RHI::ResourceDataCopyOp

  Specifies the type of one resource data copy operation.

Constants

• constexpr SubresourceIndex TEXTURE_BARRIER_ALL_SUBRESOURCES

  A special number that selects all subresources of one resource for one barrier operation.

• constexpr u32 DONT_QUERY

  A special number that identifies the query operation is disabled.

Functions

• Vector< Ref< IAdapter > > get_adapters()

  Gets a list of adapters installed on the platform.

• R< Ref< IDevice > > new_device(IAdapter *adapter)

  Creates one device using the specified adapter.

• IDevice * get_main_device()

  Gets the main device of the platform.

• BackendType get_backend_type()

  Gets the backend type.

• ShaderCompiler::TargetFormat get_current_platform_shader_target_format()

  Gets the desired shader compile target format that can be used for the current graphics API.

• ShaderData get_shader_data_from_compile_result(const ShaderCompiler::ShaderCompileResult &compile_result)

  Gets one ShaderData structure that referrs the specified compile result.

• void fill_compute_pipeline_state_desc_from_compile_result(ComputePipelineStateDesc &desc, const ShaderCompiler::ShaderCompileResult &compile_result)

  Fills cs, metal_numthreads_x, metal_numthreads_y and metal_numthreads_z properties of ComputePipelineStateDesc using shader compile results.

• usize bits_per_pixel(Format format)

  Gets the size of one pixel in the specified format, in bits.

• RV copy_resource_data(ICommandBuffer *command_buffer, Span< const CopyResourceData > copies)

  Copies data between host memory and resource memory.