Trait luminance_front::texture::Dimensionable

pub trait Dimensionable {
    type Size: Copy;
    type Offset: Copy;

    const ZERO_OFFSET: Self::Offset;

    fn dim() -> Dim;
    fn width(size: Self::Size) -> u32;
    fn x_offset(offset: Self::Offset) -> u32;
    fn count(size: Self::Size) -> usize;

    fn height(Self::Size) -> u32 { ... }
    fn depth(Self::Size) -> u32 { ... }
    fn y_offset(Self::Offset) -> u32 { ... }
    fn z_offset(Self::Offset) -> u32 { ... }
}

Class of Texture dimensions.

This trait provides a simple mapping between the implementor and the Dim type, which represents a Texture dimension. This allows to heavily type Texture so that their dimension is indexed-tracked in the type-system. This trait is then used to reify the implementors into Dim so that the runtime can work with them.

Associated Types

type Size: Copy

Size type of a dimension (used to caracterize dimensions’ areas).

type Offset: Copy

Offset type of a dimension (used to caracterize addition and subtraction of sizes, mostly).

Associated Constants

const ZERO_OFFSET: Self::Offset

Zero offset.

Any size added with ZERO_OFFSET must remain the size itself.

Required methods

fn dim() -> Dim

Reified Dim.

Implementors must ensure they map to the right variant of Dim.

fn width(size: Self::Size) -> u32

Width of the associated Dimensionable::Size.

fn x_offset(offset: Self::Offset) -> u32

X offset.

fn count(size: Self::Size) -> usize

Amount of pixels this size represents.

For 2D sizes, it represents the area; for 3D sizes, the volume; etc. For cubemaps, it represents the side length of the cube.

Provided methods

fn height(Self::Size) -> u32

Height of the associated Dimensionable::Size. If it doesn’t have one, set it to 1.

fn depth(Self::Size) -> u32

Depth of the associated Dimensionable::Size. If it doesn’t have one, set it to 1.

fn y_offset(Self::Offset) -> u32

Y offset. If it doesn’t have one, set it to 0.

fn z_offset(Self::Offset) -> u32

Z offset. If it doesn’t have one, set it to 0.

Implementors

impl Dimensionable for Cubemap

type Offset = ([u32; 2], CubeFace)

type Size = u32

const ZERO_OFFSET: <Cubemap as Dimensionable>::Offset

impl Dimensionable for Dim1

type Offset = u32

type Size = u32

const ZERO_OFFSET: <Dim1 as Dimensionable>::Offset

impl Dimensionable for Dim1Array

type Offset = (u32, u32)

type Size = (u32, u32)

const ZERO_OFFSET: <Dim1Array as Dimensionable>::Offset

impl Dimensionable for Dim2

type Offset = [u32; 2]

type Size = [u32; 2]

const ZERO_OFFSET: <Dim2 as Dimensionable>::Offset

impl Dimensionable for Dim2Array

type Offset = ([u32; 2], u32)

type Size = ([u32; 2], u32)

const ZERO_OFFSET: <Dim2Array as Dimensionable>::Offset

impl Dimensionable for Dim3

type Offset = [u32; 3]

type Size = [u32; 3]

const ZERO_OFFSET: <Dim3 as Dimensionable>::Offset