Struct Parameter 

pub struct Parameter {

    pub width: u32,
    pub height: u32,
    pub blocks_x: u32,
    pub blocks_y: u32,
    pub channel_order: u32,
    pub channel_bytes: u32,
    pub image_channels: u32,
    pub pixel_bytes: u32,
    pub image_offset: u32,
    pub image_pixel_bytes: u32,
    pub image_row_bytes: u32,
    pub alpha_pixel_bytes: u32,
    pub alpha_row_bytes: u32,
    pub block_pixels: u32,
    pub block_width: u32,
    pub block_height: u32,
    pub block_shift_x: u32,
    pub block_shift_y: u32,
}

The fields of the Parameter section, named after VOffscreen.

Fields

width: u32

Width in pixels.

height: u32

Height in pixels.

blocks_x: u32

Blocks per row.

blocks_y: u32

Block rows.

channel_order: u32

BlockDataChannelOrder: 0x21 colour (BGRA), 0x11 gray, 0x01 alpha only.

channel_bytes: u32

BlockDataChannelBytes (1).

image_channels: u32

BlockDataChannelImageCount: image channels besides alpha (4, 1, 0).

pixel_bytes: u32

BlockDataPixelBytes: bytes per pixel over all planes (5, 2, 1).

image_offset: u32

BlockDataOffsetImageBlockBytes: where the image plane starts in a block.

image_pixel_bytes: u32

BlockDataOffsetImagePixelBytes: bytes per pixel of the image plane.

image_row_bytes: u32

BlockDataOffsetImageRowBytes: bytes per row of the image plane.

alpha_pixel_bytes: u32

BlockDataOffsetAlphaPixelBytes.

alpha_row_bytes: u32

BlockDataOffsetAlphaRowBytes: bytes per row of the alpha plane.

block_pixels: u32

BlockDataOffsetImageBlock: pixels per block (65 536).

block_width: u32

Block width in pixels (256).

block_height: u32

Block height in pixels (256).

block_shift_x: u32

log2 of the block width (8).

block_shift_y: u32

log2 of the block height (8).

Implementations

impl Parameter

pub fn new(kind: PixelKind, width: u32, height: u32) -> Self

The layout CSP uses for a new offscreen of the given kind.

pub fn kind(&self) -> PixelKind

The pixel layout these values describe.

pub fn block_count(&self) -> usize

Number of blocks in the grid.

pub fn block_bytes(&self) -> usize

Bytes of one decompressed block.

pub fn block_origin(&self, index: usize) -> (u32, u32)

Top-left pixel of block index (blocks are numbered row by row).

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Parameter

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Eq for Parameter

impl PartialEq for Parameter

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Parameter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Parameter