GrapeCity.Documents.DX.WIC.BitmapEncoderOptions

Class BitmapEncoderOptions

Namespace

GrapeCity.Documents.DX.WIC

Assembly

GcDocs.DX.Windows.dll

BitmapEncoderOptions used for encoding.

public class BitmapEncoderOptions : PropertyBag, IDisposable, IUnknown

Inheritance

object

DisposeBase

CppObject

ComObject

PropertyBag

BitmapEncoderOptions

Implements

System.IDisposable

IUnknown

Inherited Members

PropertyBag.NativePointerUpdated(IntPtr)

PropertyBag.Get(string)

PropertyBag.Get<T1, T2>(PropertyBagKey<T1, T2>)

PropertyBag.Set(string, object)

PropertyBag.Set<T1, T2>(PropertyBagKey<T1, T2>, T1)

PropertyBag.Count

PropertyBag.Keys

ComObject.QueryInterface(Guid, out IntPtr)

ComObject.QueryInterfaceOrNull(Guid)

ComObject.EqualsComObject<T>(T, T)

ComObject.QueryInterface<T>()

ComObject.As<T>(object)

ComObject.As<T>(IntPtr)

ComObject.QueryInterface<T>(object)

ComObject.QueryInterfaceOrNull<T>(IntPtr)

ComObject.QueryInterfaceOrNull<T>()

ComObject.QueryInterfaceFrom<T>(T)

ComObject.Dispose(bool)

ComObject.NativePointerUpdating()

CppObject.FromTemp(CppObject)

CppObject.FromTemp(IntPtr)

CppObject.FromPointer<T>(IntPtr)

CppObject.ToCallbackPtr<TCallback>(ICallbackable)

CppObject.Tag

CppObject.NativePointer

DisposeBase.Dispose()

DisposeBase.IsDisposed

DisposeBase.Disposing

DisposeBase.Disposed

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

BitmapEncoderOptions(IntPtr)

Initializes a new instance of the BitmapEncoderOptions class.

public BitmapEncoderOptions(IntPtr propertyBagPointer)

Parameters

propertyBagPointer System.IntPtr

The property bag pointer.

Properties

AlphaDataDiscard

Gets or sets the amount of alpha frequency data to discard during a compressed domain transcode.

public byte AlphaDataDiscard { get; set; }

Property Value

byte

Remarks

Range value: 0-4 Applicable Codecs: JPEG-XR

AlphaQuality

Gets or sets the compression quality for the planar alpha channel image.

public byte AlphaQuality { get; set; }

Property Value

byte

Remarks

Range value: 1-255 Applicable Codecs: JPEG-XR

BitmapTransform

Gets or sets the bitmap transform.

public BitmapTransformOptions BitmapTransform { get; set; }

Property Value

BitmapTransformOptions

Remarks

Range value: BitmapTransformOptions Applicable Codecs: JPEG

Chrominance

Gets or sets the chrominance.

[CLSCompliant(false)]
public uint[] Chrominance { get; set; }

Property Value

uint[]

Remarks

Range value: 64 Entries (DCT) Applicable Codecs: JPEG

CompressedDomainTranscode

Enables or disables compressed domain transcoding.

public bool CompressedDomainTranscode { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: JPEG-XR

CompressionQuality

Gets or sets the compression quality.

public float CompressionQuality { get; set; }

Property Value

float

Remarks

Range value: 0-1.0f Applicable Codecs: TIFF

EnableV5Header32bppBGRA

Gets or sets a value indicating whether [EnableV5Header32bppBGRA].

public bool EnableV5Header32bppBGRA { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: BMP

FilterOption

Gets or sets the filter option.

public PngFilterOption FilterOption { get; set; }

Property Value

PngFilterOption

Remarks

Range value: PngFilterOption Applicable Codecs: PNG

FrequencyOrder

Enables encoding in frequency order.

public bool FrequencyOrder { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: JPEG-XR

HorizontalTileSlices

Gets or sets the number of horizontal tiles.

[CLSCompliant(false)]
public ushort HorizontalTileSlices { get; set; }

Property Value

ushort

Remarks

Range value: 0–4095 Applicable Codecs: JPEG-XR

IgnoreOverlap

Specifies how the encoder handles tile boundaries during a compressed domain transcode.

public bool IgnoreOverlap { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: JPEG-XR

ImageDataDiscard

Gets or sets the amount of image frequency data to discard during a compressed domain transcode.

public byte ImageDataDiscard { get; set; }

Property Value

byte

Remarks

Range value: 0–3 Applicable Codecs: JPEG-XR

ImageQuality

Gets or sets the image quality.

public float ImageQuality { get; set; }

Property Value

float

Remarks

Range value: 0-1.0f Applicable Codecs: JPEG, HDPhoto

InterlaceOption

Gets or sets a value indicating whether [interlace option].

public bool InterlaceOption { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: PNG

InterleavedAlpha

Specifies whether to encode interleaved alpha or planar alpha.

public bool InterleavedAlpha { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: JPEG-XR

JpegYCrCbSubsampling

Gets or sets the JPEG Y cr cb subsampling.

public JpegYCrCbSubsamplingOption JpegYCrCbSubsampling { get; set; }

Property Value

JpegYCrCbSubsamplingOption

Remarks

Range value: JpegYCrCbSubsamplingOption Applicable Codecs: JPEG

Lossless

Gets or sets a value indicating whether loss less compression is enabled.

public bool Lossless { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: HDPhoto

Luminance

Gets or sets the luminance.

[CLSCompliant(false)]
public uint[] Luminance { get; set; }

Property Value

uint[]

Remarks

Range value: 64 Entries (DCT) Applicable Codecs: JPEG

Overlap

Gets or sets the level of overlap filtering.

public byte Overlap { get; set; }

Property Value

byte

Remarks

Range value: 0–4 Applicable Codecs: JPEG-XR

ProgressiveMode

Enables or disables progressive encoding.

public bool ProgressiveMode { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: JPEG-XR

Quality

Gets or sets the compression quality.

public byte Quality { get; set; }

Property Value

byte

Remarks

Range value: 1–255 Applicable Codecs: JPEG-XR

StreamOnly

Enables or disables stream-only mode.

public bool StreamOnly { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: JPEG-XR

Subsampling

Gets or sets the chroma subsampling.

public byte Subsampling { get; set; }

Property Value

byte

Remarks

Range value: 0–3 Applicable Codecs: JPEG-XR

SuppressApp0

Gets or sets a value indicating whether [suppress app0].

public bool SuppressApp0 { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: JPEG

TiffCompressionMethod

Gets or sets the TIFF compression method.

public TiffCompressionOption TiffCompressionMethod { get; set; }

Property Value

TiffCompressionOption

Remarks

Range value: TiffCompressionOption Applicable Codecs: TIFF

UseCodecOptions

Specifies whether to use the Quality, Overlap, and Subsampling properties instead of the generic ImageQuality property.

public bool UseCodecOptions { get; set; }

Property Value

bool

Remarks

Range value: true-false Applicable Codecs: JPEG-XR

VerticalTileSlices

Gets or sets the number of vertical tiles.

[CLSCompliant(false)]
public ushort VerticalTileSlices { get; set; }

Property Value

ushort

Remarks

Range value: 0–4095 Applicable Codecs: JPEG-XR