pub struct GraphicsRenderer { /* private fields */ }Expand description
Graphics renderer for sixel images
Implementations§
Source§impl GraphicsRenderer
impl GraphicsRenderer
Sourcepub fn new(
device: &Device,
surface_format: TextureFormat,
cell_width: f32,
cell_height: f32,
window_padding: f32,
scaling_mode: ImageScalingMode,
preserve_aspect_ratio: bool,
) -> Result<Self>
pub fn new( device: &Device, surface_format: TextureFormat, cell_width: f32, cell_height: f32, window_padding: f32, scaling_mode: ImageScalingMode, preserve_aspect_ratio: bool, ) -> Result<Self>
Create a new graphics renderer
Sourcepub fn get_or_create_texture(
&mut self,
device: &Device,
queue: &Queue,
id: u64,
rgba_data: &[u8],
width: u32,
height: u32,
) -> Result<()>
pub fn get_or_create_texture( &mut self, device: &Device, queue: &Queue, id: u64, rgba_data: &[u8], width: u32, height: u32, ) -> Result<()>
Create or get a cached texture for a sixel graphic
§Arguments
device- WGPU device for creating texturesqueue- WGPU queue for writing texture dataid- Unique identifier for this sixel graphicrgba_data- RGBA pixel data (width * height * 4 bytes)width- Image width in pixelsheight- Image height in pixels
Sourcepub fn render(
&mut self,
device: &Device,
queue: &Queue,
render_pass: &mut RenderPass<'_>,
graphics: &[(u64, isize, usize, usize, usize, f32, usize)],
window_width: f32,
window_height: f32,
) -> Result<()>
pub fn render( &mut self, device: &Device, queue: &Queue, render_pass: &mut RenderPass<'_>, graphics: &[(u64, isize, usize, usize, usize, f32, usize)], window_width: f32, window_height: f32, ) -> Result<()>
Render sixel graphics
§Arguments
device- WGPU device for creating buffersqueue- WGPU queue for writing buffer datarender_pass- Active render pass to render intographics- Slice of sixel graphics to render with their positions Each tuple contains: (id, row, col, width_in_cells, height_in_cells, alpha, scroll_offset_rows)window_width- Window width in pixelswindow_height- Window height in pixels
Sourcepub fn render_for_pane(
&mut self,
device: &Device,
queue: &Queue,
render_pass: &mut RenderPass<'_>,
graphics: &[(u64, isize, usize, usize, usize, f32, usize)],
window_width: f32,
window_height: f32,
pane_origin_x: f32,
pane_origin_y: f32,
) -> Result<()>
pub fn render_for_pane( &mut self, device: &Device, queue: &Queue, render_pass: &mut RenderPass<'_>, graphics: &[(u64, isize, usize, usize, usize, f32, usize)], window_width: f32, window_height: f32, pane_origin_x: f32, pane_origin_y: f32, ) -> Result<()>
Render sixel graphics for a specific pane using explicit origin coordinates.
Identical to [render] but uses pane_origin_x/pane_origin_y for positioning
instead of the global window_padding + content_offset values, so graphics are
placed relative to the pane rather than the full window.
§Arguments
device- WGPU device for creating buffersqueue- WGPU queue for writing buffer datarender_pass- Active render pass to render intographics- Slice of sixel graphics to render with their positionswindow_width- Window width in pixelswindow_height- Window height in pixelspane_origin_x- X pixel coordinate of the pane’s content originpane_origin_y- Y pixel coordinate of the pane’s content origin
Sourcepub fn remove_texture(&mut self, id: u64)
pub fn remove_texture(&mut self, id: u64)
Remove a texture from the cache
Sourcepub fn clear_cache(&mut self)
pub fn clear_cache(&mut self)
Clear all cached textures
Sourcepub fn cache_size(&self) -> usize
pub fn cache_size(&self) -> usize
Get the number of cached textures
Sourcepub fn update_cell_dimensions(
&mut self,
cell_width: f32,
cell_height: f32,
window_padding: f32,
)
pub fn update_cell_dimensions( &mut self, cell_width: f32, cell_height: f32, window_padding: f32, )
Update cell dimensions (called when window is resized)
Sourcepub fn set_content_offset_y(&mut self, offset: f32)
pub fn set_content_offset_y(&mut self, offset: f32)
Set vertical content offset (e.g., tab bar height)
Sourcepub fn set_content_offset_x(&mut self, offset: f32)
pub fn set_content_offset_x(&mut self, offset: f32)
Set horizontal content offset (e.g., tab bar on left)
Sourcepub fn set_preserve_aspect_ratio(&mut self, preserve: bool)
pub fn set_preserve_aspect_ratio(&mut self, preserve: bool)
Update the global aspect ratio preservation setting.
Sourcepub fn update_scaling_mode(
&mut self,
device: &Device,
scaling_mode: ImageScalingMode,
)
pub fn update_scaling_mode( &mut self, device: &Device, scaling_mode: ImageScalingMode, )
Update the texture scaling mode (nearest vs linear filtering).
This recreates the sampler and invalidates all cached textures since their bind groups reference the old sampler.
Auto Trait Implementations§
impl Freeze for GraphicsRenderer
impl !RefUnwindSafe for GraphicsRenderer
impl Send for GraphicsRenderer
impl Sync for GraphicsRenderer
impl Unpin for GraphicsRenderer
impl UnsafeUnpin for GraphicsRenderer
impl !UnwindSafe for GraphicsRenderer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more