Skip to main content

Texture2D

Struct Texture2D 

Source
pub struct Texture2D {
    pub width: u32,
    pub height: u32,
    pub format: TextureFormat,
    pub data: Vec<u8>,
    pub mip_levels: u32,
    pub label: Option<String>,
}
Expand description

CPU-side 2D texture bytes.

Fields§

§width: u32

Width in texels.

§height: u32

Height in texels.

§format: TextureFormat

Texture format.

§data: Vec<u8>

Contiguous texture bytes.

§mip_levels: u32

Number of mip levels. 0 means base data with auto generation later.

§label: Option<String>

Optional debug label.

Implementations§

Source§

impl Texture2D

Source

pub fn new( width: u32, height: u32, format: TextureFormat, data: Vec<u8>, ) -> Result<Self, ValidationError>

Creates a base-level texture and validates byte size.

Source

pub fn with_mip_levels( width: u32, height: u32, format: TextureFormat, data: Vec<u8>, mip_levels: u32, ) -> Result<Self, ValidationError>

Creates a texture with explicit mip-level count and validates byte size.

Source

pub fn from_mips( width: u32, height: u32, format: TextureFormat, mips: Vec<Vec<u8>>, ) -> Result<Self, ValidationError>

Creates a texture from explicit mip levels and flattens the data.

Source

pub fn labeled(self, label: impl Into<String>) -> Self

Returns this texture with a label.

Source

pub fn base_level_len(&self) -> Result<usize, ValidationError>

Returns the expected byte length of the base mip level.

Source

pub fn mip_level_range( &self, level: u32, ) -> Result<Range<usize>, ValidationError>

Returns the byte range occupied by one mip level in data.

Source

pub fn validate(&self) -> Result<(), ValidationError>

Validates dimensions and byte length.

Trait Implementations§

Source§

impl Clone for Texture2D

Source§

fn clone(&self) -> Texture2D

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Texture2D

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Texture2D

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Texture2D

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.