Struct Instance

#[non_exhaustive]
pub struct Instance { /* private fields */ }

The single instance for using citro3d. This is the base type that an application should instantiate to use this library.

Implementations

impl Instance

pub fn new() -> Result<Self>

Initialize the default citro3d instance.

Errors

Fails if citro3d cannot be initialized.

pub fn with_cmdbuf_size(size: usize) -> Result<Self>

Initialize the instance with a specified command buffer size.

Errors

Fails if citro3d cannot be initialized.

pub fn render_target<'screen>( &self, width: usize, height: usize, screen: RefMut<'screen, dyn Screen>, depth_format: Option<DepthFormat>, ) -> Result<Target<'screen>>

Create a new render target with the specified size, color format, and depth format.

Errors

Fails if the target could not be created with the given parameters.

pub fn render_frame_with<'istance: 'frame, 'frame>( &'istance mut self, f: impl FnOnce(RenderPass<'frame>) -> RenderPass<'frame>, )

Render a frame.

The passed in function/closure can access a RenderPass to emit draw calls.

Trait Implementations

impl Debug for Instance

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

Formats the value using the given formatter.

impl Drop for Instance

fn drop(&mut self)

Executes the destructor for this type.