GrapeCity.Documents

GrapeCity.Documents.DX.WIC.BitmapEncoder

Class BitmapEncoder

Namespace: GrapeCity.Documents.DX.WIC

Assembly: GcDocs.DX.Windows.dll

IWICBitmapEncoder

[Guid("00000103-a8f2-4877-ba0a-fd2b6645fb94")]
public class BitmapEncoder : ComObject, IDisposable, IUnknown

Inheritance: object

DisposeBase

CppObject

ComObject

BitmapEncoder

Implements: System.IDisposable

IUnknown

: BmpBitmapEncoder

GifBitmapEncoder

JpegBitmapEncoder

PngBitmapEncoder

TiffBitmapEncoder

WmpBitmapEncoder

Inherited Members: 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.NativePointerUpdating()

ComObject.NativePointerUpdated(IntPtr)

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

BitmapEncoder(IntPtr)

Initializes a new instance of the BitmapEncoder class.

public BitmapEncoder(IntPtr nativePtr)

Parameters

nativePtr System.IntPtr: The native pointer.

Methods

Commit()

HRESULT IWICBitmapEncoder::Commit()

public void Commit()

Create(ImagingFactory, Guid, WicStream)

Initializes a new instance of the BitmapEncoder class.

public static BitmapEncoder Create(ImagingFactory factory, Guid containerFormatGuid, WicStream stream)

Parameters

factory ImagingFactory: The factory.
containerFormatGuid System.Guid: The container format GUID. List from ContainerFormatGuids
stream WicStream: A stream to use as the output of this bitmap encoder.

Returns

BitmapEncoder

Create(ImagingFactory, Guid, Guid, WicStream)

Initializes a new instance of the BitmapEncoder class.

public static BitmapEncoder Create(ImagingFactory factory, Guid containerFormatGuid, Guid guidVendorRef, WicStream stream)

Parameters

factory ImagingFactory: The factory.
containerFormatGuid System.Guid: The container format GUID. List from ContainerFormatGuids
guidVendorRef System.Guid: The GUID vendor ref.
stream WicStream: A stream to use as the output of this bitmap encoder.

Returns

BitmapEncoder

Create(ImagingFactory, Guid, Guid, Stream)

Initializes a new instance of the BitmapEncoder class.

public static BitmapEncoder Create(ImagingFactory factory, Guid containerFormatGuid, Guid guidVendorRef, Stream stream)

Parameters

factory ImagingFactory: The factory.
containerFormatGuid System.Guid: The container format GUID. List from ContainerFormatGuids
guidVendorRef System.Guid: The GUID vendor ref.
stream System.IO.Stream: A stream to use as the output of this bitmap encoder.

Returns

BitmapEncoder

Create(ImagingFactory, Guid, Guid)

Initializes a new instance of the BitmapEncoder class.

public static BitmapEncoder Create(ImagingFactory factory, Guid containerFormatGuid, Guid guidVendorRef)

Parameters

factory ImagingFactory: The factory.
containerFormatGuid System.Guid: The container format GUID. List from ContainerFormatGuids
guidVendorRef System.Guid: The GUID vendor ref.

Returns

BitmapEncoder

Create(ImagingFactory, Guid, Stream)

Initializes a new instance of the BitmapEncoder class.

public static BitmapEncoder Create(ImagingFactory factory, Guid containerFormatGuid, Stream stream)

Parameters

factory ImagingFactory: The factory.
containerFormatGuid System.Guid: The container format GUID. List from ContainerFormatGuids
stream System.IO.Stream: A stream to use as the output of this bitmap encoder.

Returns

BitmapEncoder

Create(ImagingFactory, Guid)

Initializes a new instance of the BitmapEncoder class.

public static BitmapEncoder Create(ImagingFactory factory, Guid containerFormatGuid)

Parameters

factory ImagingFactory: The factory.
containerFormatGuid System.Guid: The container format GUID. List from ContainerFormatGuids

Returns

BitmapEncoder

CreateNewFrame(PropertyBag)

HRESULT IWICBitmapEncoder::CreateNewFrame([Out, Fast] IWICBitmapFrameEncode** ppIFrameEncode,[Out, Fast] IPropertyBag2** ppIEncoderOptions)

public BitmapFrameEncode CreateNewFrame(PropertyBag encoderOptionsOut)

Parameters

encoderOptionsOut PropertyBag

Returns

BitmapFrameEncode

Dispose(bool)

Clean up any resources being used.

protected override void Dispose(bool disposing)

Parameters

disposing bool

GetContainerFormat()

HRESULT IWICBitmapEncoder::GetContainerFormat([Out] GUID* pguidContainerFormat)

public Guid GetContainerFormat()

Returns

System.Guid

GetEncoderInfo()

HRESULT IWICBitmapEncoder::GetEncoderInfo([Out] IWICBitmapEncoderInfo** ppIEncoderInfo)

public BitmapEncoderInfo GetEncoderInfo()

Returns

BitmapEncoderInfo

GetMetadataQueryWriter()

HRESULT IWICBitmapEncoder::GetMetadataQueryWriter([Out] IWICMetadataQueryWriter** ppIMetadataQueryWriter)

public MetadataQueryWriter GetMetadataQueryWriter()

Returns

MetadataQueryWriter

Initialize(IStream)

Initializes the encoder with the provided stream.

public void Initialize(IStream stream)

Parameters

stream IStream: The stream to use for initialization.

Initialize(Stream)

Initializes the encoder with the provided stream.

public void Initialize(Stream stream)

Parameters

stream System.IO.Stream: The stream to use for initialization.

SetColorContexts(ColorContext[])

Sets the ColorContext objects for the encoder.

public void SetColorContexts(ColorContext[] colorContextOut)

Parameters

colorContextOut ColorContext[]: The color contexts to set for the encoder.

SetColorContexts(int, ComArray<ColorContext>)

HRESULT IWICBitmapEncoder::SetColorContexts([In] unsigned int cCount,[In, Buffer] IWICColorContext** ppIColorContext)

public void SetColorContexts(int count, ComArray<ColorContext> colorContextOut)

Parameters

count int
colorContextOut ComArray<ColorContext>

SetColorContexts(int, ColorContext[])

HRESULT IWICBitmapEncoder::SetColorContexts([In] unsigned int cCount,[In, Buffer] IWICColorContext** ppIColorContext)

public void SetColorContexts(int count, ColorContext[] colorContextOut)

Parameters

count int
colorContextOut ColorContext[]

SetPalette(Palette)

HRESULT IWICBitmapEncoder::SetPalette([In, Optional] IWICPalette* pIPalette)

public void SetPalette(Palette paletteRef)

Parameters

paletteRef Palette

SetPreview(BitmapSource)

HRESULT IWICBitmapEncoder::SetPreview([In, Optional] IWICBitmapSource* pIPreview)

public void SetPreview(BitmapSource previewRef)

Parameters

previewRef BitmapSource

SetThumbnail(BitmapSource)

HRESULT IWICBitmapEncoder::SetThumbnail([In, Optional] IWICBitmapSource* pIThumbnail)

public void SetThumbnail(BitmapSource thumbnailRef)

Parameters

thumbnailRef BitmapSource

Operators

explicit operator BitmapEncoder(IntPtr)

Performs an explicit conversion from System.IntPtr to BitmapEncoder.

public static explicit operator BitmapEncoder(IntPtr nativePointer)

Parameters

nativePointer System.IntPtr

Returns

BitmapEncoder