Trait luminance::texture::Dimensionable

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

    pub const ZERO_OFFSET: Self::Offset;

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

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

Reify a type into a Dim.

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).

Loading content...

Associated Constants

pub const ZERO_OFFSET: Self::Offset

Zero offset.

Loading content...

Required methods

pub fn dim() -> Dim

Dimension.

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

Width of the associated Dimensionable::Size.

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

X offset.

pub 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.

Loading content...

Provided methods

pub fn height(_: Self::Size) -> u32

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

pub fn depth(_: Self::Size) -> u32

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

pub fn y_offset(_: Self::Offset) -> u32

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

pub fn z_offset(_: Self::Offset) -> u32

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

Loading content...

Implementors

impl Dimensionable for Cubemap

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

type Size = u32

pub const ZERO_OFFSET: Self::Offset

pub fn dim() -> Dim

pub fn width(s: Self::Size) -> u32

pub fn height(s: Self::Size) -> u32

pub fn depth(_: Self::Size) -> u32

pub fn x_offset(off: Self::Offset) -> u32

pub fn y_offset(off: Self::Offset) -> u32

pub fn z_offset(off: Self::Offset) -> u32

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

impl Dimensionable for Dim1

type Offset = u32

type Size = u32

pub const ZERO_OFFSET: Self::Offset

pub fn dim() -> Dim

pub fn width(w: Self::Size) -> u32

pub fn x_offset(off: Self::Offset) -> u32

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

impl Dimensionable for Dim1Array

type Offset = (u32, u32)

type Size = (u32, u32)

pub const ZERO_OFFSET: Self::Offset

pub fn dim() -> Dim

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

pub fn height(size: Self::Size) -> u32

pub fn x_offset(off: Self::Offset) -> u32

pub fn y_offset(off: Self::Offset) -> u32

pub fn count((width, layer): Self::Size) -> usize

impl Dimensionable for Dim2

type Offset = [u32; 2]

type Size = [u32; 2]

pub const ZERO_OFFSET: Self::Offset

pub fn dim() -> Dim

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

pub fn height(size: Self::Size) -> u32

pub fn x_offset(off: Self::Offset) -> u32

pub fn y_offset(off: Self::Offset) -> u32

pub fn count([width, height]: Self::Size) -> usize

impl Dimensionable for Dim2Array

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

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

pub const ZERO_OFFSET: Self::Offset

pub fn dim() -> Dim

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

pub fn height(size: Self::Size) -> u32

pub fn depth(size: Self::Size) -> u32

pub fn x_offset(off: Self::Offset) -> u32

pub fn y_offset(off: Self::Offset) -> u32

pub fn z_offset(off: Self::Offset) -> u32

pub fn count(([width, height], layer): Self::Size) -> usize

impl Dimensionable for Dim3

type Offset = [u32; 3]

type Size = [u32; 3]

pub const ZERO_OFFSET: Self::Offset

pub fn dim() -> Dim

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

pub fn height(size: Self::Size) -> u32

pub fn depth(size: Self::Size) -> u32

pub fn x_offset(off: Self::Offset) -> u32

pub fn y_offset(off: Self::Offset) -> u32

pub fn z_offset(off: Self::Offset) -> u32

pub fn count([width, height, depth]: Self::Size) -> usize

Loading content...