Byte Engine Docs
View on docs.rs

sink

Generated Rust API reference for byte_engine.

byte_engine / rendering / sink


Module sink

Per-output render target state passed to render passes.

Quick Reference

ItemKindDescription
SinkstructThe Sink struct provides a per-frame render destination for a resolved camera view.

Structs

Sink

struct Sink {
    // [REDACTED: Private Fields]
}

Defined in crates/byte-engine/src/rendering/sink.rs:11-15

The Sink struct provides a per-frame render destination for a resolved camera view.

It keeps the view transform, renderable extent, and renderer sink index together while scene managers and render passes prepare an output surface.

Implementations

  • fn new(view: View, extent: Extent, index: usize) -> Self

    Related: View

    Creates a sink for render passes that target a specific view and extent.

  • fn view(&self) -> View

    Related: View

    Returns the camera or light view used by this render target.

  • fn extent(&self) -> Extent

    Returns the pixel extent available to render passes for this sink.

  • fn view_projection(&self) -> Matrix

    Returns the combined projection and view matrix for shader setup.

  • fn index(&self) -> usize

    Returns the renderer-local sink index.

Trait Implementations

impl ArchivePointee for Sink
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for Sink
impl Clone for Sink
  • fn clone(&self) -> Sink

    Related: Sink

impl Copy for Sink
impl Debug for Sink
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for Sink
  • fn into_any(self: Box<T>) -> Box<dyn Any>
  • fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
  • fn as_any(&self) -> &dyn Any
  • fn as_any_mut(&mut self) -> &mut dyn Any
impl DowncastSend for Sink
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for Sink
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Instrument for Sink
impl LayoutRaw for Sink
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for Sink
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointable for Sink
  • const ALIGN: usize
  • type Init = T
  • unsafe fn init(init: <T as Pointable>::Init) -> usize
  • unsafe fn deref<'a>(ptr: usize) -> &'a T
  • unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
  • unsafe fn drop(ptr: usize)
impl Pointee for Sink
  • type Metadata = ()
impl Read for Sink
impl WithSubscriber for Sink

On this page