Struct dx::platform::core::Bitmap

pub struct Bitmap { /* private fields */ }

Implementations

impl Bitmap

pub fn new_for_data(
    width: u32,
    height: u32,
    format: PixelFormat,
    rowstride: u32,
    data: &[u8]
) -> Bitmap

Creates a bitmap using some existing data. The data is not copied so the application must keep the buffer alive for the lifetime of the Bitmap. This can be used for example with Framebuffer::read_pixels_into_bitmap to read data directly into an application buffer with the specified rowstride.

context

A Context

width

The width of the bitmap.

height

The height of the bitmap.

format

The format of the pixel data.

rowstride

The rowstride of the bitmap (the number of bytes from the start of one row of the bitmap to the next).

data

A pointer to the data. The bitmap will take ownership of this data.

Returns

A new Bitmap.

pub fn from_buffer(
    buffer: Bytes,
    format: PixelFormat,
    width: u32,
    height: u32,
    rowstride: u32,
    offset: i32
) -> Bitmap

pub fn from_file(filename: &str) -> Bitmap

pub fn with_size(
    context: &Context,
    width: u32,
    height: u32,
    format: PixelFormat
) -> Bitmap

pub fn buffer(&self) -> Option<PixelBuffer>

Returns

the PixelBuffer that this buffer uses for storage. Note that if the bitmap was created with Bitmap::new_from_file then it will not actually be using a pixel buffer and this fn will return None.

pub fn format(&self) -> PixelFormat

Returns

the PixelFormat that the data for the bitmap is in.

pub fn height(&self) -> u32

Returns

the height of the bitmap

pub fn rowstride(&self) -> u32

Returns

the rowstride of the bitmap. This is the number of bytes between the address of start of one row to the address of the next row in the image.

pub fn width(&self) -> u32

Returns

the width of the bitmap

pub fn size_from_file(filename: &str) -> (bool, u32, u32)

Parses an image file enough to extract the width and height of the bitmap.

filename

the file to check

width

return location for the bitmap width, or None

height

return location for the bitmap height, or None

Returns

true if the image was successfully parsed

Trait Implementations

impl Clone for Bitmap

fn clone(&self) -> Bitmap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitmap

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

Formats the value using the given formatter.

impl Display for Bitmap

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

Formats the value using the given formatter.