[−][src]Enum gfx_core::format::SurfaceType

#[repr(u8)]
pub enum SurfaceType {
    R4_G4,
    R4_G4_B4_A4,
    R5_G5_B5_A1,
    R5_G6_B5,
    R8,
    R8_G8,
    R8_G8_B8_A8,
    R10_G10_B10_A2,
    R11_G11_B10,
    R16,
    R16_G16,
    R16_G16_B16,
    R16_G16_B16_A16,
    R32,
    R32_G32,
    R32_G32_B32,
    R32_G32_B32_A32,
    B8_G8_R8_A8,
    D16,
    D24,
    D24_S8,
    D32,
    BC1_R8_G8_B8,
    BC3_R8_G8_B8_A8,
}

Type of the allocated texture surface. It is supposed to only carry information about the number of bits per each channel. The actual types are up to the views to decide and interpret. The actual components are up to the swizzle to define.

Variants

R4_G4

R4_G4_B4_A4

R5_G5_B5_A1

R5_G6_B5

R8

R8_G8

R8_G8_B8_A8

R10_G10_B10_A2

R11_G11_B10

R16

R16_G16

R16_G16_B16

R16_G16_B16_A16

R32

R32_G32

R32_G32_B32

R32_G32_B32_A32

B8_G8_R8_A8

D16

D24

D24_S8

D32

BC1_R8_G8_B8

Block Compression 1 also known as DXT1, S3TC. See S3TC wiki.

Currently supported in the gfx_device_gl backend only.

BC3_R8_G8_B8_A8

Block Compression 3 also known as DXT5, S3TC. See S3TC wiki.

Currently supported in the gfx_device_gl backend only.

Methods

`impl SurfaceType`[src]

`pub fn get_total_bits(&self) -> u8`[src]

Return the total number of bits for this format.

`pub fn get_alpha_stencil_bits(&self) -> u8`[src]

Return the number of bits allocated for alpha and stencil.

Trait Implementations

`impl Eq for SurfaceType`[src]

`impl Copy for SurfaceType`[src]

`impl PartialOrd<SurfaceType> for SurfaceType`[src]

`fn partial_cmp(&self, other: &SurfaceType) -> Option<Ordering>`[src]

`#[must_use] fn lt(&self, other: &Rhs) -> bool`
1.0.0
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

`#[must_use] fn le(&self, other: &Rhs) -> bool`
1.0.0
[src]

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

`#[must_use] fn gt(&self, other: &Rhs) -> bool`
1.0.0
[src]

This method tests greater than (for self and other) and is used by the > operator. Read more

`#[must_use] fn ge(&self, other: &Rhs) -> bool`
1.0.0
[src]

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

`impl PartialEq<SurfaceType> for SurfaceType`[src]

`fn eq(&self, other: &SurfaceType) -> bool`[src]

`#[must_use] fn ne(&self, other: &Rhs) -> bool`
1.0.0
[src]

This method tests for !=.

`impl Clone for SurfaceType`[src]

`fn clone(&self) -> SurfaceType`[src]

`fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from source. Read more

`impl Ord for SurfaceType`[src]

`fn cmp(&self, other: &SurfaceType) -> Ordering`[src]

`fn max(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the maximum of two values. Read more

`fn min(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the minimum of two values. Read more

`fn clamp(self, min: Self, max: Self) -> Self`[src]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval. Read more

`impl Debug for SurfaceType`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Hash for SurfaceType`[src]

`fn hash<H: Hasher>(&self, state: &mut H)`[src]

`fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,`
1.3.0
[src]

Feeds a slice of this type into the given [Hasher]. Read more

Auto Trait Implementations

`impl Send for SurfaceType`

`impl Sync for SurfaceType`

Blanket Implementations

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> From for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

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

`impl<T> Borrow for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> BorrowMut for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

[−][src]Enum gfx_core::format::SurfaceType

Variants

Methods

impl SurfaceType[src]

pub fn get_total_bits(&self) -> u8[src]

pub fn get_alpha_stencil_bits(&self) -> u8[src]

Trait Implementations

impl Eq for SurfaceType[src]

impl Copy for SurfaceType[src]

impl PartialOrd<SurfaceType> for SurfaceType[src]

fn partial_cmp(&self, other: &SurfaceType) -> Option<Ordering>[src]

#[must_use] fn lt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use] fn le(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use] fn gt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use] fn ge(&self, other: &Rhs) -> bool1.0.0[src]

impl PartialEq<SurfaceType> for SurfaceType[src]

fn eq(&self, other: &SurfaceType) -> bool[src]

#[must_use] fn ne(&self, other: &Rhs) -> bool1.0.0[src]

impl Clone for SurfaceType[src]

fn clone(&self) -> SurfaceType[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Ord for SurfaceType[src]

fn cmp(&self, other: &SurfaceType) -> Ordering[src]

fn max(self, other: Self) -> Self1.21.0[src]

fn min(self, other: Self) -> Self1.21.0[src]

fn clamp(self, min: Self, max: Self) -> Self[src]

impl Debug for SurfaceType[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

impl Hash for SurfaceType[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher, 1.3.0[src]

Auto Trait Implementations

impl Send for SurfaceType

impl Sync for SurfaceType