Struct Renderer 

pub struct Renderer<'a> { /* private fields */ }

The renderer for the Grafo library. This is the main struct used to render shapes and images.

Implementations

impl<'a> Renderer<'a>

pub async fn new( window: impl Into<SurfaceTarget<'static>>, physical_size: (u32, u32), scale_factor: f64, vsync: bool, transparent: bool, msaa_samples: u32, ) -> Self

pub fn print_memory_usage_info(&self)

pub async fn new_transparent( window: impl Into<SurfaceTarget<'static>>, physical_size: (u32, u32), scale_factor: f64, vsync: bool, msaa_samples: u32, ) -> Self

pub async fn try_new_headless( physical_size: (u32, u32), scale_factor: f64, ) -> Result<Self, RendererCreationError>

Creates a headless renderer without a window surface.

Use render_to_buffer() or render_to_argb32() to read back rendered pixels. Calling render() on a headless renderer will panic.

Returns an error if no suitable GPU adapter is available, the device cannot be created, or the scale_factor is invalid.

pub async fn new_headless(physical_size: (u32, u32), scale_factor: f64) -> Self

Creates a headless renderer without a window surface, panicking on any error from Self::try_new_headless (e.g. no suitable GPU adapter, invalid scale factor, device/queue creation failure).

Use render_to_buffer() or render_to_argb32() to read back rendered pixels. Calling render() on a headless renderer will panic.

For a non-panicking alternative (e.g. in tests), use Self::try_new_headless instead.

impl<'a> Renderer<'a>

pub fn add_shape( &mut self, shape: impl Into<Shape>, clip_to_shape: Option<usize>, cache_key: Option<u64>, ) -> usize

pub fn load_shape( &mut self, shape: impl AsRef<Shape>, cache_key: u64, tessellation_cache_key: Option<u64>, )

pub fn add_cached_shape_to_the_render_queue( &mut self, cache_key: u64, clip_to_shape: Option<usize>, ) -> usize

pub fn texture_manager(&self) -> &TextureManager

pub fn clear_draw_queue(&mut self)

pub fn set_shape_transform_cols(&mut self, node_id: usize, cols: [[f32; 4]; 4])

pub fn set_shape_transform( &mut self, node_id: usize, transform: impl Into<InstanceTransform>, )

pub fn set_shape_texture(&mut self, node_id: usize, texture_id: Option<u64>)

pub fn set_shape_texture_layer( &mut self, node_id: usize, layer: usize, texture_id: Option<u64>, )

pub fn set_shape_texture_on( &mut self, node_id: usize, layer: TextureLayer, texture_id: Option<u64>, )

pub fn set_shape_color(&mut self, node_id: usize, color: Option<Color>)

impl<'a> Renderer<'a>

pub fn load_effect( &mut self, effect_id: u64, pass_sources: &[&str], ) -> Result<(), EffectError>

pub fn set_group_effect( &mut self, node_id: usize, effect_id: u64, params: &[u8], ) -> Result<(), EffectError>

pub fn update_group_effect_params( &mut self, node_id: usize, params: &[u8], ) -> Result<(), EffectError>

pub fn remove_group_effect(&mut self, node_id: usize)

pub fn set_shape_backdrop_effect( &mut self, node_id: usize, effect_id: u64, params: &[u8], ) -> Result<(), EffectError>

pub fn update_backdrop_effect_params( &mut self, node_id: usize, params: &[u8], ) -> Result<(), EffectError>

pub fn remove_backdrop_effect(&mut self, node_id: usize)

pub fn unload_effect(&mut self, effect_id: u64)

impl<'a> Renderer<'a>

pub fn render_to_buffer(&mut self, buffer: &mut Vec<u8>)

pub fn render_to_argb32(&mut self, out_pixels: &mut [u32])

impl<'a> Renderer<'a>

pub fn render(&mut self) -> Result<(), SurfaceError>

impl<'a> Renderer<'a>

pub fn size(&self) -> (u32, u32)

pub fn change_scale_factor(&mut self, new_scale_factor: f64)

pub fn scale_factor(&self) -> f64

pub fn set_fringe_width(&mut self, fringe_width: f32)

pub fn fringe_width(&self) -> f32

pub fn resize(&mut self, new_physical_size: (u32, u32))

pub fn msaa_samples(&self) -> u32

pub fn set_msaa_samples(&mut self, samples: u32)

pub fn set_surface(&mut self, window: impl Into<SurfaceTarget<'static>>)

pub fn set_vsync(&mut self, vsync: bool)