Type Alias PixelImage

pub type PixelImage<Storage, Channels> = Image<Layer<SpecificChannels<Storage, Channels>>>;

This image type contains a single layer containing a user-defined type of pixels.

Aliased Type

struct PixelImage<Storage, Channels> {
    pub attributes: ImageAttributes,
    pub layer_data: Layer<SpecificChannels<Storage, Channels>>,
}

Fields

attributes: ImageAttributes

Attributes that apply to the whole image file. These attributes appear in each layer of the file. Excludes technical meta data. Each layer in this image also has its own attributes.

layer_data: Layer<SpecificChannels<Storage, Channels>>

The layers contained in the image file. Can be either a single Layer or a list of layers.

Implementations

impl<'s, InnerLayers> Image<InnerLayers>

where InnerLayers: WritableLayers<'s> + 's,

pub fn with_layer<NewChannels>( self, layer: Layer<NewChannels>, ) -> Image<Recursive<InnerLayers, Layer<NewChannels>>>

where NewChannels: 's + WritableChannels<'s>,

Add another layer to this image. The layer type does not have to equal the existing layers in this image.

impl<'s, ChannelData> Image<Layer<ChannelData>>

where ChannelData: WritableChannels<'s> + 's,

pub fn from_layer(layer: Layer<ChannelData>) -> Self

Uses the display position and size to the channel position and size of the layer.

pub fn from_encoded_channels( size: impl Into<Vec2<usize>>, encoding: Encoding, channels: ChannelData, ) -> Self

Uses empty attributes.

pub fn from_channels( size: impl Into<Vec2<usize>>, channels: ChannelData, ) -> Self

Uses empty attributes and fast compression.

impl<'s, LayerData> Image<LayerData>

where LayerData: WritableLayers<'s> + 's,

pub fn new(image_attributes: ImageAttributes, layer_data: LayerData) -> Self

Create an image with one or multiple layers. The layer can be a Layer, or Layers small vector, or Vec<Layer> or &[Layer].

Trait Implementations

impl<Layers: Clone> Clone for Image<Layers>

fn clone(&self) -> Image<Layers>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Layers: Debug> Debug for Image<Layers>

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

Formats the value using the given formatter.

impl<Layers: PartialEq> PartialEq for Image<Layers>

fn eq(&self, other: &Image<Layers>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C> ValidateResult for Image<C>

where C: ValidateResult,

fn validate_result( &self, other: &Self, options: ValidationOptions, location: impl Fn() -> String, ) -> ValidationResult

Compare self with the other. Exceptional behaviour:

fn assert_equals_result(&self, result: &Self)

Compare self with the other. Panics if not equal.

impl<Layers> StructuralPartialEq for Image<Layers>