Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 2.25 KB

File metadata and controls

25 lines (19 loc) · 2.25 KB

Openize.Heic.Decoder.HeicImage

Heic image class.

Properties

Name Type Description Notes
Header HeicHeader Heic image header. Grants convinient access to IsoBmff container meta data.
Frames Dictionary<uint, HeicImageFrame> Dictionary of public Heic image frames with access by identifier.
AllFrames Dictionary<uint, HeicImageFrame> Dictionary of all Heic image frames with access by identifier.
DefaultFrame HeicImageFrame Returns the default image frame, which is specified in meta data.
Width uint Width of the default image frame in pixels.
Height uint Height of the default image frame in pixels.

Methods

Name Type Description Parameters Notes
Load HeicImage Reads the file meta data and creates a class object for further decoding of the file contents. Stream stream - File stream. This operation does not decode pixels.
Use the default frame methods GetByteArray or GetInt32Array afterwards in order to decode pixels.
CanLoad bool Checks if the stream can be read as a heic image.
Returns true if file header contains heic signarure, false otherwise
Stream stream - File stream.
GetByteArray byte[] Get pixel data of the default image frame in the format of byte array.
Each three or four bytes (the count depends on the pixel format) refer to one pixel left to right top to bottom line by line.
Returns null if frame does not contain image data.
PixelFormat pixelFormat - Pixel format that defines the order of colors and the presence of alpha byte.
Rectangle boundsRectangle - Bounds of the requested area.
GetInt32Array int[] Get pixel data of the default image frame in the format of integer array.
Each int value refers to one pixel left to right top to bottom line by line.
Returns null if frame does not contain image data.
PixelFormat pixelFormat - Pixel format that defines the order of colors.
Rectangle boundsRectangle - Bounds of the requested area.

[Back to API_README]