Struct Renderer 

pub struct Renderer { /* private fields */ }

Immediate mode renderer.

This object allows one to render graphics into arbitrary vectors, holding any QuantizePixel types. The typical flow of each frame is as follows:

1. Clear the framebuffer with Renderer::clear_screen.
2. First pass object rendering with Renderer::render.
3. Second pass text rendering with Renderer::text_pass.

The end result may look something like this:

   ...   .   .   ..    ...   .  . .  .   .. .    ..  .    .
 ..    .  . .. ... . . ...  ==. . .  .  .     . . ..   ..  .
  .      ..   ..   ==+===================..  ...... . .   ..
 .      .  .   ..##=++==========+=+====+=...   ..... . ..  .
      ..    .    .####===.........+=====.. ..  ..        ...
.  .  .......     .###%%#.Example.=====......     .      . .
. .  . .     .      ####%.........=+== .   ..     .  .    .
    .  . ..  ..   . .##########+=====.. ...  . . . .  .  . .
.  ..  . . . .  ..     ########==+==.=+ .... .  ...    . .
.    . .  .     . .... ..######===. .  +==    .. .. .     ..
  ..  ..    ....    .  ..  ###=== .    .  +++.    .. ..   ..
   .    ... .... .  .. .    .#= .          ..++=... ...  . .
.   .    .  .. ..  .. .. ....  .       ....    .=++..  ... .
 . ...      ...  . ...      ...  . ...      ...  . ++.

Implementations

impl Renderer

pub fn clear_screen<T: QuantizePixel>( &mut self, bg: &Background, conv_params: &T::Params, dithering: &mut impl Dithering, buf: &mut Vec<T>, w: usize, h: usize, )

Clears the screen with specified background.

This function must be called before every Renderer::render call, because it sets internal buffers up with specified dimensions.

The buf should be then passed to subsequent renderer calls, without having its dimensions modified beforehand.

pub fn render<T: QuantizePixel, M: Material + ?Sized>( &mut self, camera: &Camera, conv_params: &T::Params, mats: &mut [impl AsMut<M>], objects: &[Object], dithering: &mut impl Dithering, buf: &mut Vec<T>, )

Draws objects on screen.

This function takes a list of objects, their materials, and draws them to given buffer. Note that buf must be first cleared using Renderer::clear_screen function.

pub fn text_pass<T: PixelText + QuantizePixel>( &mut self, objects: &[Object], buf: &mut Vec<T>, )

Draws text on top of rendered objects.

This function takes a list of objects (the identical set, to previously passed to Renderer::render), and draws auxiliary text, if it was set.

Trait Implementations

impl Debug for Renderer

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

Formats the value using the given formatter.

impl Default for Renderer

fn default() -> Renderer

Returns the “default value” for a type.