Class TgaEncoder

Image encoder for writing an image to a stream as a targa truevision image.

Inheritance
Object
ImageEncoder
TgaEncoder
Implements
Inherited Members
Namespace: SixLabors.ImageSharp.Formats.Tga
Assembly: SixLabors.ImageSharp.dll
Syntax
public sealed class TgaEncoder : ImageEncoder, IImageEncoder

Properties

| Improve this Doc View Source

BitsPerPixel

Gets the number of bits per pixel.

Declaration
public TgaBitsPerPixel? BitsPerPixel { get; set; }
Property Value
Type Description
Nullable<TgaBitsPerPixel>
| Improve this Doc View Source

Compression

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

Declaration
public TgaCompression Compression { get; set; }
Property Value
Type Description
TgaCompression

Methods

| Improve this Doc View Source

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

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

Declaration
protected override void Encode<TPixel>(Image<TPixel> image, Stream stream, CancellationToken cancellationToken)
    where TPixel : struct, IPixel<TPixel>
Parameters
Type Name Description
Image<TPixel> image

The Image<TPixel> to encode from.
Stream stream

The to encode the image data to.
CancellationToken cancellationToken

The token to monitor for cancellation requests.
Type Parameters
Name Description
TPixel

The pixel format.
Overrides
SixLabors.ImageSharp.Formats.ImageEncoder.Encode<TPixel>(SixLabors.ImageSharp.Image<TPixel>, Stream, CancellationToken)
Remarks

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

Implements