Enum spirq::ty::Type

#[non_exhaustive]
pub enum Type {
    Scalar(ScalarType),
    Vector(VectorType),
    Matrix(MatrixType),
    Image(ImageType),
    CombinedImageSampler(CombinedImageSamplerType),
    SampledImage(SampledImageType),
    StorageImage(StorageImageType),
    Sampler(SamplerType),
    SubpassData(SubpassDataType),
    Array(ArrayType),
    Struct(StructType),
    AccelStruct(AccelStructType),
    DeviceAddress(DeviceAddressType),
    DevicePointer(PointerType),
    RayQuery(RayQueryType),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Scalar(ScalarType)

A single value, which can be a signed or unsigned integer, a floating point number, or a boolean value.

Vector(VectorType)

A collection of scalars.

Matrix(MatrixType)

A collection of vectors.

Image(ImageType)

An image. In most cases, this variant is elevated to CombinedImageSampler, SampledImage, or StorageImage so you shouldn’t see this in your reflection results.

CombinedImageSampler(CombinedImageSamplerType)

A sampled image externally combined with a sampler state. Such design is preferred in OpenGL and Vulkan.

SampledImage(SampledImageType)

A sampled image yet to be combined with a Sampler. Such design is preferred in DirectX and Vulkan.

StorageImage(StorageImageType)

A storage image that shaders can read and/or write.

Sampler(SamplerType)

Separable sampler state.

SubpassData(SubpassDataType)

Pixel store from input attachments.

Array(ArrayType)

Repetition of a single type.

Struct(StructType)

Aggregation of types.

AccelStruct(AccelStructType)

Acceleration structure for ray-tracing. Only available with RayTracingKHR capability enabled.

DeviceAddress(DeviceAddressType)

Forward-declared pointer but the type of pointed data is unknown. Usually used for GPU linked lists. See VK_KHR_buffer_device_address.

DevicePointer(PointerType)

Forward-declared pointer. Usually used for bindless resources with the buffer_reference extension. See VK_KHR_buffer_device_address.

RayQuery(RayQueryType)

Ray query payload type (rayQueryEXT). Only available with RayQueryKHR capability enabled.

Implementations

impl Type

pub fn min_nbyte(&self) -> Option<usize>

pub fn nbyte(&self) -> Option<usize>

pub fn member_offset(&self, member_index: usize) -> Option<usize>

pub fn access_ty(&self) -> Option<AccessType>

pub fn walk<'a>(&'a self) -> Walk<'a>

pub fn is_scalar(&self) -> bool

pub fn is_vector(&self) -> bool

pub fn is_matrix(&self) -> bool

pub fn is_image(&self) -> bool

pub fn is_sampler(&self) -> bool

pub fn is_combined_image_sampler(&self) -> bool

pub fn is_sampled_image(&self) -> bool

pub fn is_storage_image(&self) -> bool

pub fn is_subpass_data(&self) -> bool

pub fn is_array(&self) -> bool

pub fn is_struct(&self) -> bool

pub fn is_accel_struct(&self) -> bool

pub fn is_device_address(&self) -> bool

pub fn is_device_pointer(&self) -> bool

pub fn as_scalar(&self) -> Option<&ScalarType>

pub fn as_vector(&self) -> Option<&VectorType>

pub fn as_matrix(&self) -> Option<&MatrixType>

pub fn as_image(&self) -> Option<&ImageType>

pub fn as_sampler(&self) -> Option<&SamplerType>

pub fn as_combined_image_sampler(&self) -> Option<&CombinedImageSamplerType>

pub fn as_sampled_image(&self) -> Option<&SampledImageType>

pub fn as_storage_image(&self) -> Option<&StorageImageType>

pub fn as_subpass_data(&self) -> Option<&SubpassDataType>

pub fn as_array(&self) -> Option<&ArrayType>

pub fn as_struct(&self) -> Option<&StructType>

pub fn as_accel_struct(&self) -> Option<&AccelStructType>

pub fn as_device_address(&self) -> Option<&DeviceAddressType>

pub fn as_device_pointer(&self) -> Option<&PointerType>

pub fn mutate<F>(self, f: F) -> Type

where F: Fn(Type) -> Type,

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl Display for Type

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

Formats the value using the given formatter.

impl Hash for Type

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

where __H: Hasher,

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 Type

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Type

impl StructuralPartialEq for Type