HeifContext Class

The LibHeif context.

Definition

Namespace: LibHeifSharp
Assembly: LibHeifSharp (in LibHeifSharp.dll) Version: 3.2.0
C#
public sealed class HeifContext : Disposable
Inheritance
Object    Disposable    HeifContext

Constructors

HeifContext Initializes a new instance of the HeifContext class.
HeifContext(Byte) Initializes a new instance of the HeifContext class, with the specified byte array to read from.
HeifContext(ReadOnlyMemoryByte) Initializes a new instance of the HeifContext class, with the specified memory to read from.
HeifContext(String) Initializes a new instance of the HeifContext class, with the specified file to read from.
HeifContext(Stream, Boolean) Initializes a new instance of the HeifContext class with the specified stream to read from, and optionally leaves the stream open.

Methods

AddExifMetadata(HeifImageHandle, Byte) Adds EXIF meta-data to the image.
AddExifMetadata(HeifImageHandle, ReadOnlySpanByte) Adds EXIF meta-data to the image.
AddGenericMetadata(HeifImageHandle, String, Byte) Adds generic meta-data to the image.
AddGenericMetadata(HeifImageHandle, String, ReadOnlySpanByte) Adds generic meta-data to the image.
AddGenericMetadata(HeifImageHandle, String, String, Byte) Adds generic meta-data to the image.
AddGenericMetadata(HeifImageHandle, String, String, ReadOnlySpanByte) Adds generic meta-data to the image.
AddUserDescriptionProperty(HeifImageHandle, UserDescriptionProperty) Adds an user description property to the specified image.
AddUserDescriptionProperty(HeifItemId, UserDescriptionProperty) Adds an user description property to the specified item.
AddUserDescriptionProperty(HeifRegionItem, UserDescriptionProperty) Adds an user description property to the specified region item.
AddXmpMetadata(HeifImageHandle, Byte) Adds XMP meta-data to the image.
AddXmpMetadata(HeifImageHandle, ReadOnlySpanByte) Adds XMP meta-data to the image.
Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from Disposable)
EncodeImage Encodes the image.
EncodeImageAndReturnHandle Encodes the image and returns the resulting image handle.
EncodeThumbnail Encodes the image thumbnail.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
GetEncoder(HeifCompressionFormat) Gets the default encoder for the specified compression format.
GetEncoder(HeifEncoderDescriptor) Gets the encoder associated with the specified encoder descriptor.
GetEncoderDescriptors Gets a list of the encoder descriptors.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetImageHandle Gets the image handle for the specified image id.
GetPrimaryImageHandle Gets the image handle for the primary image.
GetRegionItem Gets the region item.
GetTopLevelImageIds Gets a list of the top-level image ids.
GetTransformationProperties Gets the transformation properties that should be applied to the specified image.
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetUserDescriptionProperties(HeifImageHandle) Gets the user description properties that are associated with the specified image.
GetUserDescriptionProperties(HeifItemId) Gets the user description properties that are associated with the specified item.
GetUserDescriptionProperties(HeifRegionItem) Gets the user description properties that are associated with the specified region item.
SetMaximumDecodingThreads Sets the maximum number of threads that LibHeif can use for decoding images.
SetMaximumImageSizeLimit Sets the maximum image size limit.
SetPrimaryImage Sets the primary image.
ToStringReturns a string that represents the current object.
(Inherited from Object)
WriteToFile Writes this instance to the specified file.
WriteToStream Writes this instance to the specified stream.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also