Skip to main content

GBufferLayout

Struct GBufferLayout 

Source
pub struct GBufferLayout {
    pub color_attachments: Vec<GBufferAttachment>,
    pub depth_attachment: GBufferAttachment,
    pub max_color_attachments: u32,
    pub use_octahedral_normals: bool,
    pub thin_gbuffer: bool,
}
Expand description

Describes the full set of attachments in a G-Buffer.

The default layout provides:

  • Position (RGBA32F) at color attachment 0
  • Normal (RG16F, octahedral encoding) at color attachment 1
  • Albedo (RGBA8) at color attachment 2
  • Emission (RGBA16F) at color attachment 3
  • MaterialID (R8) at color attachment 4
  • Roughness (R8) at color attachment 5
  • Metallic (R8) at color attachment 6
  • Depth (D32F) as the depth attachment

Fields§

§color_attachments: Vec<GBufferAttachment>

Ordered list of color attachments.

§depth_attachment: GBufferAttachment

The depth (or depth-stencil) attachment.

§max_color_attachments: u32

Maximum number of simultaneous render targets supported.

§use_octahedral_normals: bool

Whether to use octahedral normal encoding (saves bandwidth vs RGBA16F).

§thin_gbuffer: bool

Whether thin G-Buffer packing is enabled (combine roughness+metallic into one RG8).

Implementations§

Source§

impl GBufferLayout

Source

pub fn new() -> Self

Create a new empty layout.

Source

pub fn default_layout() -> Self

Create the default G-Buffer layout used by the deferred pipeline.

Source

pub fn thin_layout() -> Self

Create a thin/minimal G-Buffer layout that packs more data per attachment. Uses fewer render targets at the cost of some precision.

Source

pub fn add_color_attachment(&mut self, attachment: GBufferAttachment)

Add a color attachment to the layout.

Source

pub fn remove_attachment(&mut self, semantic: GBufferSemantic) -> bool

Remove a color attachment by semantic.

Source

pub fn find_attachment( &self, semantic: GBufferSemantic, ) -> Option<&GBufferAttachment>

Find an attachment by semantic.

Source

pub fn find_attachment_mut( &mut self, semantic: GBufferSemantic, ) -> Option<&mut GBufferAttachment>

Find an attachment by semantic (mutable).

Source

pub fn color_attachment_count(&self) -> u32

Total number of color attachments.

Source

pub fn total_memory_bytes(&self, width: u32, height: u32) -> u64

Calculate total memory usage for a given resolution.

Source

pub fn validate(&self) -> Vec<String>

Validate the layout, returning any issues found.

Trait Implementations§

Source§

impl Clone for GBufferLayout

Source§

fn clone(&self) -> GBufferLayout

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GBufferLayout

Source§

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

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

impl Default for GBufferLayout

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,