Struct graphics_buffer::RenderBuffer

pub struct RenderBuffer { /* fields omitted */ }

A buffer that can be rendered to with Piston's graphics library.

Enabling the piston_window_texture feature exposes a function called to_g2d_texture, with the following signature:

pub fn to_g2d_texture(
    &self,
    context: &mut G2dTextureContext,
    settings: &TextureSettings,
) -> Result<G2dTexture, Box<dyn std::error::Error>>;

Methods

impl RenderBuffer

pub fn new(width: u32, height: u32) -> RenderBuffer

Create a new RenderBuffer with the given witdth or height.

pub fn open<P: AsRef<Path>>(path: P) -> Result<RenderBuffer, Box<dyn Error>>

Creates a new RenderBuffer by opening it from a file.

pub fn decode_from_bytes(bytes: &[u8]) -> ImageResult<RenderBuffer>

Creates a new RenderBuffer by decoding image data.

pub fn clear(&mut self, color: [f32; 4])

Clear the buffer with a color.

pub fn pixel(&self, x: u32, y: u32) -> [f32; 4]

Returns the color of the pixel at the given coordinates.

pub fn set_pixel(&mut self, x: u32, y: u32, color: [f32; 4])

Sets the color of the pixel at the given coordinates.

Trait Implementations

impl Clone for RenderBuffer

fn clone(&self) -> RenderBuffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<ImageBuffer<Rgba<u8>, Vec<u8>>> for RenderBuffer

fn from(image: RgbaImage) -> Self

Performs the conversion.

impl From<DynamicImage> for RenderBuffer

fn from(image: DynamicImage) -> Self

Performs the conversion.

impl Deref for RenderBuffer

type Target = RgbaImage

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Debug for RenderBuffer

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

Formats the value using the given formatter.

impl Graphics for RenderBuffer

type Texture = RenderBuffer

The texture type associated with the back-end.

fn clear_color(&mut self, color: Color)

Clears background with a color.

fn clear_stencil(&mut self, _value: u8)

Clears stencil buffer with a value, usually 0.

fn tri_list<F>(&mut self, _draw_state: &DrawState, color: &[f32; 4], f: F) where
    F: FnMut(&mut dyn FnMut(&[[f32; 2]])), 

Renders list of 2d triangles using a solid color.

fn tri_list_uv<F>(
    &mut self,
    _draw_state: &DrawState,
    color: &[f32; 4],
    texture: &Self::Texture,
    f: F
) where
    F: FnMut(&mut dyn FnMut(&[[f32; 2]], &[[f32; 2]])), 

Renders list of 2d triangles using a color and a texture.

fn rectangle<R>(
    &mut self,
    r: &Rectangle,
    rectangle: R,
    draw_state: &DrawState,
    transform: [[f64; 3]; 2]
) where
    R: Into<[f64; 4]>, 

Draws a rectangle.

fn polygon(
    &mut self,
    p: &Polygon,
    polygon: &[[f64; 2]],
    draw_state: &DrawState,
    transform: [[f64; 3]; 2]
)

Draws a polygon.

fn polygon_tween_lerp(
    &mut self,
    p: &Polygon,
    polygons: &[&[[f64; 2]]],
    tween_factor: f64,
    draw_state: &DrawState,
    transform: [[f64; 3]; 2]
)

Draws a tweened polygon using linear interpolation.

fn image(
    &mut self,
    image: &Image,
    texture: &Self::Texture,
    draw_state: &DrawState,
    transform: [[f64; 3]; 2]
)

Draws image.

fn ellipse<R>(
    &mut self,
    e: &Ellipse,
    rectangle: R,
    draw_state: &DrawState,
    transform: [[f64; 3]; 2]
) where
    R: Into<[f64; 4]>, 

Draws ellipse.

fn line<L>(
    &mut self,
    l: &Line,
    line: L,
    draw_state: &DrawState,
    transform: [[f64; 3]; 2]
) where
    L: Into<[f64; 4]>, 

Draws line.

fn circle_arc<R>(
    &mut self,
    c: &CircleArc,
    rectangle: R,
    draw_state: &DrawState,
    transform: [[f64; 3]; 2]
) where
    R: Into<[f64; 4]>, 

Draws circle arc.

impl ImageSize for RenderBuffer

fn get_size(&self) -> (u32, u32)

Get the image size.

fn get_width(&self) -> u32

Gets the image width.

fn get_height(&self) -> u32

Gets the image height.

impl UpdateTexture<()> for RenderBuffer

fn update<O, S>(
    &mut self,
    _factory: &mut (),
    _format: Format,
    memory: &[u8],
    offset: O,
    size: S
) -> Result<(), Self::Error> where
    O: Into<[u32; 2]>,
    S: Into<[u32; 2]>, 

Update the texture.

impl CreateTexture<()> for RenderBuffer

fn create<S: Into<[u32; 2]>>(
    _factory: &mut (),
    _format: Format,
    memory: &[u8],
    size: S,
    _settings: &TextureSettings
) -> Result<Self, Error>

Create texture from memory.

impl TextureOp<()> for RenderBuffer

type Error = Error

The error when performing an operation.