Skip to main content

Attachment

Struct Attachment 

Source
pub struct Attachment {
    pub kind: AttachmentKind,
    pub texture: GpuTexture,
    /* private fields */
}
Expand description

A frame buffer attachment that tells the frame buffer object where to store the results of rendering.

Fields§

§kind: AttachmentKind

Current kind of attachment. Tells the renderer how the texture should be used when rendering to the frame buffer. For example, is it color or depth?

§texture: GpuTexture

A texture the renderer writes to. It may be writing the actual image, or it may just be writing the depth, or stencil, depending on kind.

Implementations§

Source§

impl Attachment

Source

pub fn level(&self) -> usize

Mip level of the texture where the rendering should happen. In most cases, it can be zero.

Source

pub fn cube_map_face(&self) -> Option<CubeMapFace>

Face of the cube map, this field is used only if the texture is a cube map. This indicates which face of the cube will be rendered to.

Source

pub fn set_level(&self, level: usize)

Mip level of the texture where the rendering should happen. In most cases, it can be zero.

Source

pub fn set_cube_map_face(&self, face: Option<CubeMapFace>)

Face of the cube map, this field is used only if the texture is a cube map. This indicates which face of the cube will be rendered to.

Source

pub fn color(texture: GpuTexture) -> Self

Creates a new AttachmentKind::Color attachment with the given texture.

Source

pub fn color_with_level(texture: GpuTexture, level: usize) -> Self

Creates a new AttachmentKind::Color attachment with the given texture and the mip level.

Source

pub fn color_with_face(texture: GpuTexture, cube_map_face: CubeMapFace) -> Self

Creates a new AttachmentKind::Color attachment with the given texture and the cube map face. The texture must be a cube map.

Source

pub fn depth(texture: GpuTexture) -> Self

Creates a new AttachmentKind::Depth attachment with the given texture.

Source

pub fn depth_stencil(texture: GpuTexture) -> Self

Creates a new AttachmentKind::DepthStencil attachment with the given texture.

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> 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, U> ObjectOrVariant<T> for U

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V