Trait rafx_framework::render_features::RenderFeatureFramePacket

pub trait RenderFeatureFramePacket: Downcast + Send + Sync {
    // Required methods
    fn get_or_push_render_object_instance(
        &mut self,
        render_object_instance: RenderObjectInstance
    ) -> RenderObjectInstanceId;
    fn render_feature_view_packet(
        &self,
        view_index: ViewFrameIndex
    ) -> &dyn RenderFeatureViewPacket;
    fn render_feature_view_packet_mut(
        &mut self,
        view_index: ViewFrameIndex
    ) -> &mut dyn RenderFeatureViewPacket;
    fn feature_index(&self) -> RenderFeatureIndex;

    // Provided methods
    fn push_render_object_instance_per_view(
        &mut self,
        view_index: ViewFrameIndex,
        render_object_instance_id: RenderObjectInstanceId,
        render_object_instance: RenderObjectInstance
    ) -> RenderObjectInstancePerViewId { ... }
    fn push_volume(&mut self, view_index: ViewFrameIndex, object_id: ObjectId) { ... }
}

A type-erased trait used by the Renderer, RenderFrameJob, and RendererThreadPool to control the workload of the rendering process without identifying specific types used in each RenderFeature’s frame packet or workload. See FramePacket and ViewPacket for implementation details.

Required Methods

fn get_or_push_render_object_instance( &mut self, render_object_instance: RenderObjectInstance ) -> RenderObjectInstanceId

fn render_feature_view_packet( &self, view_index: ViewFrameIndex ) -> &dyn RenderFeatureViewPacket

fn render_feature_view_packet_mut( &mut self, view_index: ViewFrameIndex ) -> &mut dyn RenderFeatureViewPacket

fn feature_index(&self) -> RenderFeatureIndex

Provided Methods

fn push_render_object_instance_per_view( &mut self, view_index: ViewFrameIndex, render_object_instance_id: RenderObjectInstanceId, render_object_instance: RenderObjectInstance ) -> RenderObjectInstancePerViewId

fn push_volume(&mut self, view_index: ViewFrameIndex, object_id: ObjectId)

Implementations

impl dyn RenderFeatureFramePacket

pub fn is<__T: RenderFeatureFramePacket>(&self) -> bool

Returns true if the trait object wraps an object of type __T.

pub fn downcast<__T: RenderFeatureFramePacket>( self: Box<Self> ) -> Result<Box<__T>, Box<Self>>

Returns a boxed object from a boxed trait object if the underlying object is of type __T. Returns the original boxed trait if it isn’t.

pub fn downcast_rc<__T: RenderFeatureFramePacket>( self: Rc<Self> ) -> Result<Rc<__T>, Rc<Self>>

Returns an Rc-ed object from an Rc-ed trait object if the underlying object is of type __T. Returns the original Rc-ed trait if it isn’t.

pub fn downcast_ref<__T: RenderFeatureFramePacket>(&self) -> Option<&__T>

Returns a reference to the object within the trait object if it is of type __T, or None if it isn’t.

pub fn downcast_mut<__T: RenderFeatureFramePacket>( &mut self ) -> Option<&mut __T>

Returns a mutable reference to the object within the trait object if it is of type __T, or None if it isn’t.

Trait Implementations

impl<'a> RenderFeatureFramePacketAsConcrete<'a> for dyn RenderFeatureFramePacket

fn as_concrete<T: RenderFeatureFramePacket>(&'a self) -> &'a T

Downcast &dyn RenderFeatureFramePacket into &T where T: RenderFeatureFramePacket.

impl RenderFeatureFramePacketIntoConcrete for Box<dyn RenderFeatureFramePacket>

fn into_concrete<T: RenderFeatureFramePacket>(self) -> Box<T>

Downcast Box<dyn RenderFeatureFramePacket> into Box<T> where T: RenderFeatureFramePacket.

Implementors

impl<FramePacketDataT: 'static + Sync + Send + FramePacketData> RenderFeatureFramePacket for FramePacket<FramePacketDataT>