Module hotline_rs::gfx

Graphics and compute abstraction module.

Structs

• AdapterInfo
  Information returned from Device::get_adapter_info.
• BlendInfo
  Information to control blending operations on render targets
• BufferInfo
  Information to create a buffer through Device::create_buffer.
• BufferUsage
  Describes how a buffer will be used on the GPU.
• ClearColour
  Values to clear colour render targets at the start of a RenderPass
• ClearDepthStencil
  Values to clear depth stencil buffers during a RenderPass
• ComputePipelineInfo
  Information to create a compute pipeline through Device::create_compute_pipeline
• CpuAccessFlags
  CPU Access flags for buffers or textures.
• DepthStencilInfo
  Information to control the depth and stencil testing of primitves when using a RenderPipeline
• DescriptorBinding
  Describes a range of resources for access on the GPU.
• DeviceInfo
  Information to create a device, it contains default heaps for resource views resources will be automatically allocated into these heaps, you can supply custom heaps if necessary.
• DispatchArguments
  Structure of arguments which can be used to execute dispatch calls indirectly
• DrawArguments
  Structure of arguments which can be used to execute draw_instanced calls indirectly
• DrawIndexedArguments
  Structure of arguments which can be used to execute draw_indexed_instanced calls indirectly
• HeapInfo
  Information to create a desciptor heap… Device will contain default heaps, but you can create your own if required.
• IndexBufferView
  Structure of arguments which can be used to change an index buffer during execute_indirect
• IndirectArgument
  Pair of IndirectArgumentType and IndirectTypeArguments where the type selects the union member of data
• IndirectBufferArguments
  Arguments to change a buffer during an execute_indirect call when ConstantBuffer, ShaderResource or UnorderedAccess are the IndirectArgumentType
• IndirectNoArguments
  This can be used for Draw, DrawIndexed, or Dispatch IndirectArgumentType
• IndirectPushConstantsArguments
  Arguments to change push constants during an execute_indirect call when Constant is the IndirectArgumentType
• InputElementInfo
  Describe a single element of an InputLayoutInfo.
• MapInfo
  Info to control mapping of resources for read/write access
• PipelineLayout
  PipelineLayout is required to create a pipeline it describes the layout of resources for access on the GPU.
• PipelineSlotInfo
  You can request this based on resource type, register and space (as specified in shader)
• PipelineStatistics
  GPU pipeline statistics obtain by using a PipelineStatistics query
• PushConstantInfo
  Describes space in the shader to send data to via CmdBuf::push_constants.
• QueryHeapInfo
  Information to create a query heap.
• RasterInfo
  Information to control the rasterisation mode of primitives when using a RenderPipeline
• ReadBackData
  Results from an issued ReadBackRequest
• RenderPassInfo
  Information to create a render pass
• RenderPipelineInfo
  Information to create a pipeline through Device::create_render_pipeline.
• RenderTargetBlendInfo
  Blending operations for a single render target
• SamplerBinding
  Individual sampler state binding for use in static samplers in a PipelineLayout.
• SamplerInfo
  Info to create a sampler state object to sample textures in shaders.
• ScissorRect
  Structure to specify scissor rect coordinates on a CmdBuf.
• ShaderCompileFlags
  Shader compilation flags.
• ShaderCompileInfo
  Information required to compile a shader from source code.
• ShaderInfo
  Information to create a shader through Device::create_shader.
• Size3
  3-Dimensional struct for compute shader thread count / thread group size.
• StencilInfo
  Stencil info for various outcomes of the depth stencil test
• SwapChainInfo
  Information to pass to Device::create_swap_chain.
• TextureHeapInfo
  Allows user specified heaps to be used for creating views when creating textures through create_texture_with_heap you can supply None for the heap types are not applicable and if a view is requested for a None heap the default device heaps will be used instead
• TextureInfo
  Information to create a pipeline through Device::create_texture.
• TextureUsage
  Textures can be used in one or more of the following ways
• TransitionBarrier
  Transitions are required to be performed to switch resources from reading to writing or into different formats
• UnmapInfo
  Info to control writing of mapped resources
• VertexBufferView
  Structure of arguments which can be used to change a vertex buffer during execute_indirect
• Viewport
  Structure to specify viewport coordinates on a CmdBuf.
• WriteMask
  Render target write mask flags.

Enums

• BlendFactor
  Controls how the source and destination terms in blend equation are derrived
• BlendOp
  Controls how the source and destination terms are combined: final = src (op) dest
• ComparisonFunc
  Used for comparison ops in depth testing, samplers.
• CullMode
  Polygon cull mode
• DepthWriteMask
  Write to the depth buffer, or omit writes and just perform depth testing
• DescriptorType
  Describes the type of descriptor binding to create.
• FillMode
  Polygon fillmode
• Format
  Format for resource types (textures / buffers). n = normalised unsigned integer, u = unsigned integer, i = signed integer, f = float
• HeapType
  Options for heap types.
• IndirectArgumentType
  Different types of arguments which can be changed through execute indirect calls
• InputSlotClass
  Describes the frequency of which elements are fetched from a vertex input element.
• LogicOp
  The logical operation to configure for a render target blend with logic op enabled
• PipelineType
  Enum to differentiate between render and compute pipelines but also still work on them generically
• QueryType
  Options for query heap types, and queries
• ResourceState
  All possible resource states, some for buffers and some for textures
• SamplerAddressMode
  Address mode for the sampler (controls wrapping and clamping).
• SamplerFilter
  Filtering mode for the sampler (controls bilinear and trilinear interpolation).
• ShaderType
  The stage to which a shader will bind itself.
• ShaderVisibility
  Describes the visibility of which shader stages can access a descriptor.
• StencilOp
  Stencil operations
• Subresource
  ome resources may contain subresources for resolving
• TextureType
  Describes the dimension of a texture
• Topology
  Indicates how the pipeline interprets vertex data at the input assembler stage This will be also used to infer primitive topology types for geometry or hull shaders

Traits

• Buffer
  An opaque Buffer type used for vertex, index, constant or unordered access.
• CmdBuf
  Responsible for buffering graphics commands. Internally it will contain a platform specific command list for each buffer in the associated swap chain. At the start of each frame reset must be called with an associated swap chain to internally switch which buffer we are writing to. At the end of each frame close must be called and finally the CmdBuf can be passed to Device::execute to be processed on the GPU.
• CommandSignature
  A command signature is used to execute_indirect commands
• ComputePipeline
  An opaque compute pipeline type..
• Device
  A GPU device is used to create GPU resources, the device also contains a single a single command queue to which all command buffers will submitted and executed each frame. Default heaps for shader resources, render targets and depth stencils are also provided
• Heap
  An opaque shader heap type, use to create views of resources for binding and access in shaders
• Pipeline
  A pipeline trait for shared functionality between Compute and Render pipelines
• QueryHeap
  An opaque query heap type, use to create queries
• ReadBackRequest
  Used to readback data from the GPU, once the request is issued is_complete needs to be waited on for completion you must poll this every frame and not block so the GPU can flush the request. Once the result is ready the data can be obtained using get_data
• RenderPass
  An opaque RenderPass containing an optional set of colour render targets and an optional depth stencil target
• RenderPipeline
  An opaque render pipeline type set blend, depth stencil, raster states on a pipeline, and bind with CmdBuf::set_pipeline_state
• Shader
  An opaque Shader type
• SwapChain
  A swap chain is connected to a window, controls fences and signals as we swap buffers.
• Texture
  An opaque Texture type

Functions

• align
  Aligns value to the alignment specified by align. value can be non-power of 2
• align_pow2
  Aligns value to the alignment specified by align. value must be a power of 2
• as_u8_slice
  Take any sized type and return a u8 slice. This can be useful to pass data to Device::create_buffer.
• block_size_for_format
  Returns the ‘block size’ (texel, compressed block of texels or single buffer element) for a given format
• components_for_format
  Returns the number of components for a given format. ie RGBA = 4 and RGB = 3
• mip_levels_for_dimension
  Returns the number of mip levels required for a 2D texture
• num_32bit_constants
  For the supplied sized struct &_ returns the number of 32bit constants required for use as push_constants
• row_pitch_for_format
  Returns the row pitch of an image in bytes: width * block size
• size_for_format
  Return the size in bytes of a 3 dimensional resource: width * height * depth block size
• size_for_format_mipped
  Return the size in bytes of up to dimensional resource: width * height * depth block size for each mip level and account for array layers
• slice_as_u8_slice
  Take any sized silce and convert to a slice of u8
• slice_pitch_for_format
  Returns the slice pitch of an image in bytes: width * height * block size, a slice is a single 2D image or a single slice of a 3D texture or texture array

Type Definitions

• InputLayout
  Input layout describes the layout of vertex buffers bound to the input assembler.

Unions

• IndirectTypeArguments
  Union of IndirectArguments where data can be selected by the IndirectArgumentType