Skip to main content

Pixmap

Struct Pixmap 

Source
pub struct Pixmap { /* private fields */ }
Expand description

A CPU pixel buffer in straight (non-premultiplied) RGBA8, row-major, tightly packed (stride == width * 4).

This is the payload handed to a Surface for display. It is what the software backend produces today; a future GPU backend may bypass it.

Implementations§

Source§

impl Pixmap

Source

pub fn decode(bytes: &[u8]) -> Result<Pixmap, ImageError>

Decode an image file held in memory into a straight-alpha RGBA pixmap, sniffing the format through the oxideav registry (see image_formats for the formats). Animated formats yield their first frame; images without alpha decode fully opaque.

assert_eq!(Pixmap::decode(b"not an image"), Err(ImageError::UnknownFormat));
Source

pub fn decode_with( formats: &RuntimeContext, bytes: &[u8], ) -> Result<Pixmap, ImageError>

decode through a caller-built oxideav registry, for formats beyond the built-in set.

Source

pub fn from_oxideav_image(image: &Image) -> Result<Pixmap, ImageError>

Convert a decoded oxideav-image picture (any pixel layout the stack converts from) to RGBA.

Source

pub fn from_video_frame( frame: &VideoFrame, size: PhysicalSize, format: PixelFormat, ) -> Result<Pixmap, ImageError>

Convert an oxideav VideoFrame of size pixels in format to an RGBA pixmap. Packed RGBA is copied row by row (dropping any stride padding); every other layout goes through oxideav’s pixel-format conversion (YUV, RGB, gray, palettes, 16-bit, …).

Source

pub fn to_video_frame(&self) -> VideoFrame

This pixmap as a single-plane packed RGBA (PixelFormat::Rgba) oxideav VideoFrame, for handing to the rest of the stack.

Source§

impl Pixmap

Source

pub fn new(size: PhysicalSize) -> Self

Allocate a fully transparent pixmap of size.

Source

pub fn from_rgba8(size: PhysicalSize, data: Vec<u8>) -> Self

Wrap existing RGBA8 bytes. Panics if data.len() != width*height*4.

Source

pub fn size(&self) -> PhysicalSize

Source

pub fn stride(&self) -> usize

Bytes per row.

Source

pub fn as_bytes(&self) -> &[u8] ⓘ

Source

pub fn as_bytes_mut(&mut self) -> &mut [u8] ⓘ

Source

pub fn blit(&mut self, src: &Pixmap, dst_x: u32, dst_y: u32)

Copy src into this pixmap with its top-left at (dst_x, dst_y), clipped to this pixmap’s bounds. A straight row-by-row replace (no alpha blend) — used to composite an opaque area-repaint render (see SoftwareRenderer::render_region) into the retained full-window buffer.

Source

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

The four bytes [r, g, b, a] at (x, y), or None if out of bounds.

Trait Implementations§

Source§

impl Clone for Pixmap

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Pixmap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Pixmap

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Pixmap

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.