Class TgaEncoder

Namespace

SixLabors.ImageSharp.Formats.Tga

Assembly

SixLabors.ImageSharp.dll

Image encoder for writing an image to a stream as a Targa true-vision image.

public sealed class TgaEncoder : ImageEncoder, IImageEncoder

Inheritance

object

ImageEncoder

TgaEncoder

Implements

IImageEncoder

Inherited Members

ImageEncoder.Encode<TPixel>(Image<TPixel>, Stream)

ImageEncoder.EncodeAsync<TPixel>(Image<TPixel>, Stream, CancellationToken)

ImageEncoder.SkipMetadata

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TgaEncoder()

public TgaEncoder()

Properties

BitsPerPixel

Gets the number of bits per pixel.

public TgaBitsPerPixel? BitsPerPixel { get; init; }

Property Value

TgaBitsPerPixel?

Compression

Gets a value indicating whether no compression or run length compression should be used.

public TgaCompression Compression { get; init; }

Property Value

TgaCompression

Methods

Encode<TPixel>(Image<TPixel>, Stream, CancellationToken)

Encodes the image to the specified stream from the Image<TPixel>.

protected override void Encode<TPixel>(Image<TPixel> image, Stream stream, CancellationToken cancellationToken) where TPixel : unmanaged, IPixel<TPixel>

Parameters

image Image<TPixel>

The Image<TPixel> to encode from.

stream Stream

The Stream to encode the image data to.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Type Parameters

TPixel

The pixel format.

Remarks

This method is designed to support the ImageSharp internal infrastructure and is not recommended for direct use.