RealmOA Library

oa::render::Renderer

Engine-borrowing headless render-to-texture session. Admits multiple frame sources through the same slot-ring lifecycle. submit_frame returns a RenderFrame carrying the color Texture and exact producer Event.

StRust public API

Declaration

pub struct Renderer<'engine> { /* private fields */ }
Public Rust declaration.

Public Methods

pub fn config(&self) -> &RendererConfig
pub fn has_mesh_path(&self) -> bool
pub fn register_texture( &self, handle: TextureHandle, texture: &Texture, ) -> Result<()>
pub fn begin_frame(&self, source: &Texture) -> Result<()>
pub fn begin_frame_mesh(&self, mesh: &MeshData, camera: &Camera) -> Result<()>
pub fn begin_frame_flat_color( &self, mesh: &MeshData, camera: &Camera, material: &FlatColorMaterial, ) -> Result<()>
pub fn begin_frame_unlit( &self, mesh: &MeshData, camera: &Camera, material: &UnlitMaterial, ) -> Result<()>
pub fn begin_frame_scene(&self, scene: &Scene, camera: &Camera) -> Result<()>
pub fn submit_frame(&self) -> Result<RenderFrame>
pub fn cancel_frame(&self) -> Result<()>
pub fn collect(&self) -> Result<usize>
pub fn close(&self) -> Result<()>

Associated Functions

pub fn new(engine: &'engine Engine, config: RendererConfig) -> Result<Self>

Public Method Documentation

pub fn config( &self ) -> &RendererConfig
No public source comment is attached to this declaration.
pub fn has_mesh_path( &self ) -> bool
No public source comment is attached to this declaration.
pub fn register_texture( &self, handle: TextureHandle, texture: &Texture, ) -> Result<()>
No public source comment is attached to this declaration.
pub fn begin_frame(&self, source: &Texture) -> Result<()>
No public source comment is attached to this declaration.
pub fn begin_frame_mesh(&self, mesh: &MeshData, camera: &Camera) -> Result<()>
No public source comment is attached to this declaration.
pub fn begin_frame_flat_color( &self, mesh: &MeshData, camera: &Camera, material: &FlatColorMaterial, ) -> Result<()>
No public source comment is attached to this declaration.
pub fn begin_frame_unlit( &self, mesh: &MeshData, camera: &Camera, material: &UnlitMaterial, ) -> Result<()>
No public source comment is attached to this declaration.
pub fn begin_frame_scene(&self, scene: &Scene, camera: &Camera) -> Result<()>
No public source comment is attached to this declaration.
pub fn submit_frame( &self ) -> Result<RenderFrame>
No public source comment is attached to this declaration.
pub fn cancel_frame(&self) -> Result<()>
No public source comment is attached to this declaration.
pub fn collect( &self ) -> Result<usize>
No public source comment is attached to this declaration.
pub fn close(&self) -> Result<()>
No public source comment is attached to this declaration.
pub fn new( engine: &'engine Engine, config: RendererConfig ) -> Result<Self>
No public source comment is attached to this declaration.