Struct vulkano::sampler::ComponentMapping

pub struct ComponentMapping {
    pub r: ComponentSwizzle,
    pub g: ComponentSwizzle,
    pub b: ComponentSwizzle,
    pub a: ComponentSwizzle,
}

A mapping between components of a source format and components read by a shader.

Fields

r: ComponentSwizzle

First component.

g: ComponentSwizzle

Second component.

b: ComponentSwizzle

Third component.

a: ComponentSwizzle

Fourth component.

Implementations

impl ComponentMapping

pub fn identity() -> Self

Creates a ComponentMapping with all components identity swizzled.

pub fn is_identity(&self) -> bool

Returns true if all components are identity swizzled, meaning that all the members are Identity or the name of that member.

Certain operations require views that are identity swizzled, and will return an error otherwise. For example, attaching a view to a framebuffer is only possible if the view is identity swizzled.

pub fn r_is_identity(&self) -> bool

Returns true if the red component mapping is identity swizzled.

pub fn g_is_identity(&self) -> bool

Returns true if the green component mapping is identity swizzled.

pub fn b_is_identity(&self) -> bool

Returns true if the blue component mapping is identity swizzled.

pub fn a_is_identity(&self) -> bool

Returns true if the alpha component mapping is identity swizzled.

pub fn component_map(&self) -> [Option<usize>; 4]

Returns the component indices that each component reads from. The index is None if the component has a fixed value and is not read from anywhere (Zero or One).

Trait Implementations

impl Clone for ComponentMapping

fn clone(&self) -> ComponentMapping

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentMapping

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

Formats the value using the given formatter.

impl Default for ComponentMapping

fn default() -> ComponentMapping

Returns the “default value” for a type.

impl From<ComponentMapping> for ComponentMapping

fn from(value: ComponentMapping) -> Self

Converts to this type from the input type.

impl PartialEq<ComponentMapping> for ComponentMapping

fn eq(&self, other: &ComponentMapping) -> 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 Copy for ComponentMapping

impl Eq for ComponentMapping

impl StructuralEq for ComponentMapping

impl StructuralPartialEq for ComponentMapping