Struct Options

pub struct Options {
    pub shader_model: ShaderModel,
    pub binding_map: BindingMap,
    pub fake_missing_bindings: bool,
    pub special_constants_binding: Option<BindTarget>,
    pub push_constants_target: Option<BindTarget>,
    pub sampler_heap_target: SamplerHeapBindTargets,
    pub sampler_buffer_binding_map: SamplerIndexBufferBindingMap,
    pub dynamic_storage_buffer_offsets_targets: DynamicStorageBufferOffsetsTargets,
    pub external_texture_binding_map: ExternalTextureBindingMap,
    pub zero_initialize_workgroup_memory: bool,
    pub restrict_indexing: bool,
    pub force_loop_bounding: bool,
}

Configuration used in the Writer.

Fields

shader_model: ShaderModel

The hlsl shader model to be used

binding_map: BindingMap

HLSL binding information for each Naga global variable.

This maps Naga GlobalVariable’s ResourceBindings to a BindTarget specifying its register number and space, along with other details necessary to generate a full HLSL declaration for it, or to access its value.

This must provide a BindTarget for every GlobalVariable in the Module that has a binding.

fake_missing_bindings: bool

Don’t panic on missing bindings, instead generate any HLSL.

special_constants_binding: Option<BindTarget>

Add special constants to SV_VertexIndex and SV_InstanceIndex, to make them work like in Vulkan/Metal, with help of the host.

push_constants_target: Option<BindTarget>

HLSL binding information for the PushConstant global, if present.

If a module contains a global in the PushConstant address space, the dx12 backend stores its value directly in the root signature as a series of D3D12_ROOT_PARAMETER_TYPE_32BIT_CONSTANTS, whose binding information is given here.

sampler_heap_target: SamplerHeapBindTargets

HLSL binding information for the sampler heap and comparison sampler heap.

sampler_buffer_binding_map: SamplerIndexBufferBindingMap

Mapping of each bind group’s sampler index buffer to a bind target.

dynamic_storage_buffer_offsets_targets: DynamicStorageBufferOffsetsTargets

Bind target for dynamic storage buffer offsets

external_texture_binding_map: ExternalTextureBindingMap

HLSL binding information for External image global variables.

See ExternalTextureBindTarget for details.

zero_initialize_workgroup_memory: bool

Should workgroup variables be zero initialized (by polyfilling)?

restrict_indexing: bool

Should we restrict indexing of vectors, matrices and arrays?

force_loop_bounding: bool

If set, loops will have code injected into them, forcing the compiler to think the number of iterations is bounded.

Implementations

impl Options

fn resolve_resource_binding( &self, res_binding: &ResourceBinding, ) -> Result<BindTarget, EntryPointError>

fn resolve_external_texture_resource_binding( &self, res_binding: &ResourceBinding, ) -> Result<ExternalTextureBindTarget, EntryPointError>

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Options

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

where Options: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Options

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Options

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Options

impl StructuralPartialEq for Options