zilinsoft
b4e236fd55
------ #### OnLineUpgradeConfig V1.0.2501.0601 - *.[修复]修复用户管理列表无法默认勾选已选择用户的BUG。 #### RaUI V4.0.2501.0601 - *.[新增]RyFiles类新增SetFileDate、SetFileCreationTime、SetFileLastWriteTime方法。 - *.[新增]RyFiles.CopyBigFile方法现在会同步来源文件的创建和修改时间。 - *.[新增]ryQuickSQL类新增GetPostData函数,将数据快速转成Post数据。 - *.[改进]执行MySQL下的ExecuteNonQuery时,如果遇到连接关闭错误,允许重连并重新执行。 - *.[改进]IDbInterface在执行新的SQL语句前,自动清空最后错误。 - *.[修复]修复LayeredForm窗体以正常窗体打开的时候,文本框无法编辑的BUG。 - *.[修复]修复ApkOp获取apk权限时可能带乱码的BUG。 - *.[修复]修复WeifenLuo.WinFormsUI.Docking的ResourceManager.GetString路径不对导致报错的BUG。
5436 lines
250 KiB
XML
5436 lines
250 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>LibHeifSharp</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:LibHeifSharp.AuxiliaryImageType">
|
|
<summary>
|
|
The type of auxiliary image that a <see cref="T:LibHeifSharp.HeifImageHandle"/> represents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.AuxiliaryImageType.None">
|
|
<summary>
|
|
The image handle is not an auxiliary image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.AuxiliaryImageType.Depth">
|
|
<summary>
|
|
The image handle is a depth image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.AuxiliaryImageType.Thumbnail">
|
|
<summary>
|
|
The image handle is a thumbnail.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.AuxiliaryImageType.VendorSpecific">
|
|
<summary>
|
|
The image handle is a vendor-specific auxiliary image.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.ColorPrimaries">
|
|
<summary>
|
|
The NCLX color primaries
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.BT709">
|
|
<summary>
|
|
BT.709
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.Unspecified">
|
|
<summary>
|
|
Unspecified
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.BT470M">
|
|
<summary>
|
|
BT.470 System M (historical)
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.BT470BG">
|
|
<summary>
|
|
BT.470 System B, G (historical)
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.BT601">
|
|
<summary>
|
|
BT.601
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.Smpte240">
|
|
<summary>
|
|
SMPTE 240
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.GenericFilm">
|
|
<summary>
|
|
Generic film (color filters using illuminant C)
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.BT2020">
|
|
<summary>
|
|
BT.2020-2, BT.2100-0
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.Smpte428">
|
|
<summary>
|
|
SMPTE 428 (CIE 1921 XYZ)
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.Smpte431">
|
|
<summary>
|
|
SMPTE RP 431-2
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.Smpte432">
|
|
<summary>
|
|
SMPTE EG 432-1
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorPrimaries.Ebu3213">
|
|
<summary>
|
|
EBU Tech. 3213-E
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.ColorProfileType">
|
|
<summary>
|
|
The type of color profile.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorProfileType.Nclx">
|
|
<summary>
|
|
A NCLX color profile
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.ColorProfileType.Icc">
|
|
<summary>
|
|
An ICC color profile.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifColorProfile">
|
|
<summary>
|
|
The base class for a HEIF image color profile.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifColorProfile.ProfileType">
|
|
<summary>
|
|
Gets the type of the color profile.
|
|
</summary>
|
|
<value>
|
|
The type of the color profile.
|
|
</value>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifIccColorProfile">
|
|
<summary>
|
|
Represents an International Color Consortium (ICC) color profile.
|
|
</summary>
|
|
<seealso cref="P:LibHeifSharp.HeifImage.IccColorProfile" qualifyHint="true"/>
|
|
<seealso cref="P:LibHeifSharp.HeifImageHandle.IccColorProfile" qualifyHint="true"/>
|
|
<seealso cref="T:LibHeifSharp.HeifColorProfile" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifIccColorProfile.#ctor(System.Byte[])">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifIccColorProfile"/> class.
|
|
</summary>
|
|
<param name="iccProfile">The ICC profile.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="iccProfile"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="iccProfile"/> is empty.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifIccColorProfile.#ctor(System.ReadOnlyMemory{System.Byte})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifIccColorProfile"/> class.
|
|
</summary>
|
|
<param name="iccProfile">The ICC profile.</param>
|
|
<exception cref="T:System.ArgumentException"><paramref name="iccProfile"/> is empty.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifIccColorProfile.#ctor(System.Byte[],System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifIccColorProfile"/> class.
|
|
</summary>
|
|
<param name="iccProfile">The ICC profile.</param>
|
|
<param name="copyToNewArray">
|
|
<see langword="true"/> if the parameter should be copied to a new array; otherwise, <see langword="false"/>
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="iccProfile"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="iccProfile"/> is empty.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifIccColorProfile.AsSpan">
|
|
<summary>
|
|
Creates a new read-only span over the ICC profile data.
|
|
</summary>
|
|
<returns>The read-only span representation of the ICC profile data.</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifIccColorProfile.GetIccProfileBytes">
|
|
<summary>
|
|
Gets a copy of the ICC profile data.
|
|
</summary>
|
|
<returns>A copy of the ICC profile data.</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifIccColorProfile.TryCreate(LibHeifSharp.Interop.SafeHeifImageHandle)">
|
|
<summary>
|
|
Create a <see cref="T:LibHeifSharp.HeifIccColorProfile"/> from the specified image handle.
|
|
</summary>
|
|
<param name="handle">The handle.</param>
|
|
<returns>The created profile.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The ICC profile is larger than 2 GB.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifIccColorProfile.TryCreate(LibHeifSharp.Interop.SafeHeifImage)">
|
|
<summary>
|
|
Create a <see cref="T:LibHeifSharp.HeifIccColorProfile"/> from the specified image.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
<returns>The created profile.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The ICC profile is larger than 2 GB.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifIccColorProfile.SetImageColorProfile(LibHeifSharp.Interop.SafeHeifImage)">
|
|
<summary>
|
|
Sets the image color profile.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifNclxColorProfile">
|
|
<summary>
|
|
Represents a NCLX color profile.
|
|
</summary>
|
|
<seealso cref="P:LibHeifSharp.HeifImage.NclxColorProfile" qualifyHint="true"/>
|
|
<seealso cref="P:LibHeifSharp.HeifImageHandle.NclxColorProfile" qualifyHint="true"/>
|
|
<seealso cref="T:LibHeifSharp.HeifColorProfile" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifNclxColorProfile.#ctor(LibHeifSharp.ColorPrimaries,LibHeifSharp.TransferCharacteristics,LibHeifSharp.MatrixCoefficients,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifNclxColorProfile"/> class.
|
|
</summary>
|
|
<param name="colorPrimaries">The color primaries.</param>
|
|
<param name="transferCharacteristics">The transfer characteristics.</param>
|
|
<param name="matrixCoefficients">The matrix coefficients.</param>
|
|
<param name="fullRange"><see langword="true"/> if the full color range is used; otherwise, <see langword="false"/>.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifNclxColorProfile.ColorPrimaries">
|
|
<summary>
|
|
Gets the color primaries.
|
|
</summary>
|
|
<value>
|
|
The color primaries.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifNclxColorProfile.TransferCharacteristics">
|
|
<summary>
|
|
Gets the transfer characteristics.
|
|
</summary>
|
|
<value>
|
|
The transfer characteristics.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifNclxColorProfile.MatrixCoefficients">
|
|
<summary>
|
|
Gets the matrix coefficients.
|
|
</summary>
|
|
<value>
|
|
The matrix coefficients.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifNclxColorProfile.FullRange">
|
|
<summary>
|
|
Gets a value indicating whether the full color range is used.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if the full color range is used; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifNclxColorProfile.TryCreate(LibHeifSharp.Interop.SafeHeifImageHandle)">
|
|
<summary>
|
|
Create a <see cref="T:LibHeifSharp.HeifNclxColorProfile"/> from the specified image handle.
|
|
</summary>
|
|
<param name="handle">The handle.</param>
|
|
<returns>The created profile.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifNclxColorProfile.TryCreate(LibHeifSharp.Interop.SafeHeifImage)">
|
|
<summary>
|
|
Create a <see cref="T:LibHeifSharp.HeifNclxColorProfile"/> from the specified image.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
<returns>The created profile.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifNclxColorProfile.SetImageColorProfile(LibHeifSharp.Interop.SafeHeifImage)">
|
|
<summary>
|
|
Sets the image color profile.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The native NCLX profile creation failed.
|
|
|
|
-or-
|
|
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.MatrixCoefficients">
|
|
<summary>
|
|
The NCLX matrix coefficients
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.Identity">
|
|
<summary>
|
|
Identity matrix
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.BT709">
|
|
<summary>
|
|
BT.709
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.Unspecified">
|
|
<summary>
|
|
Unspecified
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.Reserved3">
|
|
<summary>
|
|
For future use
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.FCC">
|
|
<summary>
|
|
US FCC 73.628
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.BT470BG">
|
|
<summary>
|
|
BT.470 System B, G (historical)
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.BT601">
|
|
<summary>
|
|
BT.601
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.Smpte240">
|
|
<summary>
|
|
SMPTE 240 M
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.YCgCo">
|
|
<summary>
|
|
YCgCo
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.BT2020NCL">
|
|
<summary>
|
|
BT.2020-2 non-constant luminance, BT.2100-0 YCbCr
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.BT2020CL">
|
|
<summary>
|
|
BT.2020-2 constant luminance
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.Smpte2085">
|
|
<summary>
|
|
SMPTE ST 2085
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.CromatNCL">
|
|
<summary>
|
|
Chromaticity-derived non-constant luminance
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.CromatCL">
|
|
<summary>
|
|
Chromaticity-derived constant luminance
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MatrixCoefficients.ICtCp">
|
|
<summary>
|
|
BT.2100-0 ICtCp
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransferCharacteristics">
|
|
<summary>
|
|
The NCLX transfer characteristics
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Reserved0">
|
|
<summary>
|
|
For future use
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.BT709">
|
|
<summary>
|
|
BT.709
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Unspecified">
|
|
<summary>
|
|
Unspecified
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Reserved3">
|
|
<summary>
|
|
For future use
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.BT470M">
|
|
<summary>
|
|
BT.470 System M (historical)
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.BT470BG">
|
|
<summary>
|
|
BT.470 System B, G (historical)
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.BT601">
|
|
<summary>
|
|
BT.601
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Smpte240">
|
|
<summary>
|
|
SMPTE 240
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Linear">
|
|
<summary>
|
|
Linear
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Log100">
|
|
<summary>
|
|
Logarithmic (100 : 1 range)
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Log100Sqrt10">
|
|
<summary>
|
|
Logarithmic (100 * Sqrt(10) : 1 range)
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.IEC61966">
|
|
<summary>
|
|
IEC 61966-2-4
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.BT1361">
|
|
<summary>
|
|
BT.1361
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Srgb">
|
|
<summary>
|
|
sRGB or sYCC
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.BT2020TenBit">
|
|
<summary>
|
|
BT.2020-2 10-bit systems
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.BT2020TwelveBit">
|
|
<summary>
|
|
BT.2020-2 12-bit systems
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Smpte2084">
|
|
<summary>
|
|
SMPTE ST 2084, ITU BT.2100-0 PQ
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.Smpte428">
|
|
<summary>
|
|
SMPTE ST 428-1
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransferCharacteristics.HLG">
|
|
<summary>
|
|
BT.2100-0 HLG, ARIB STD-B67
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifBooleanEncoderParameter">
|
|
<summary>
|
|
Represents a Boolean encoder parameter.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.HeifEncoderParameter`1" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifBooleanEncoderParameter.#ctor(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifBooleanEncoderParameter" /> class.
|
|
</summary>
|
|
<param name="name">The parameter name.</param>
|
|
<param name="hasDefaultValue"><see langword="true"/> if the parameter has a default value; otherwise, <see langword="false"/>.</param>
|
|
<param name="defaultValue">The default value.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifBooleanEncoderParameter.ParameterType">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifEncoderParameter`1">
|
|
<summary>
|
|
The base class for the LibHeif encoder parameters
|
|
</summary>
|
|
<typeparam name="T">The encoder parameter type.</typeparam>
|
|
<seealso cref="T:LibHeifSharp.IHeifEncoderParameter" />
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderParameter`1.DefaultValue">
|
|
<summary>
|
|
Gets the default value of this parameter.
|
|
</summary>
|
|
<value>
|
|
The default value of this parameter.
|
|
</value>
|
|
<remarks>
|
|
The value of this property is only meaningful when <see cref="P:LibHeifSharp.HeifEncoderParameter`1.HasDefault"/> is <see langword="true"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderParameter`1.HasDefault">
|
|
<summary>
|
|
Gets a value indicating whether this parameter has a default value.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if this parameter has a default value; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderParameter`1.Name">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderParameter`1.ParameterType">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoderParameterFactory.Create(LibHeifSharp.Interop.SafeHeifEncoder,LibHeifSharp.Interop.heif_encoder_parameter)">
|
|
<summary>
|
|
Creates the specified encoder parameter.
|
|
</summary>
|
|
<param name="encoder">The encoder.</param>
|
|
<param name="nativeParameter">The native encoder parameter.</param>
|
|
<returns></returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">An error occurred when creating the encoder parameter.</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifEncoderParameterType">
|
|
<summary>
|
|
The type of the encoder parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifEncoderParameterType.Boolean">
|
|
<summary>
|
|
The parameter is a <see cref="T:LibHeifSharp.HeifBooleanEncoderParameter"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifEncoderParameterType.Integer">
|
|
<summary>
|
|
The parameter is a <see cref="T:LibHeifSharp.HeifIntegerEncoderParameter"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifEncoderParameterType.String">
|
|
<summary>
|
|
The parameter is a <see cref="T:LibHeifSharp.HeifStringEncoderParameter"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifIntegerEncoderParameter">
|
|
<summary>
|
|
Represents an Integer LibHeif encoder parameter
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.HeifEncoderParameter`1" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifIntegerEncoderParameter.#ctor(System.String,System.Boolean,System.Int32,System.Boolean,System.Int32,System.Int32,System.Collections.ObjectModel.ReadOnlyCollection{System.Int32})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifIntegerEncoderParameter"/> class.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="hasDefaultValue"><see langword="true"/> if this instance has a default value; otherwise, <see langword="false"/></param>
|
|
<param name="defaultValue">The default value.</param>
|
|
<param name="hasMinimumMaximum"><see langword="true"/> if this instance has minimum and maximum values; otherwise, <see langword="false"/></param>
|
|
<param name="minimum">The minimum.</param>
|
|
<param name="maximum">The maximum.</param>
|
|
<param name="validValues">The valid values.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifIntegerEncoderParameter.HasMinimumMaximum">
|
|
<summary>
|
|
Gets a value indicating whether this instance has minimum and maximum values.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if this instance has minimum and maximum values; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifIntegerEncoderParameter.Minimum">
|
|
<summary>
|
|
Gets the minimum value.
|
|
</summary>
|
|
<value>
|
|
The minimum value.
|
|
</value>
|
|
<remarks>
|
|
The value of this property is only meaningful when <see cref="P:LibHeifSharp.HeifIntegerEncoderParameter.HasMinimumMaximum"/> is <see langword="true"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifIntegerEncoderParameter.Maximum">
|
|
<summary>
|
|
Gets the maximum value.
|
|
</summary>
|
|
<value>
|
|
The maximum value.
|
|
</value>
|
|
<remarks>
|
|
The value of this property is only meaningful when <see cref="P:LibHeifSharp.HeifIntegerEncoderParameter.HasMinimumMaximum"/> is <see langword="true"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifIntegerEncoderParameter.ValidValues">
|
|
<summary>
|
|
Gets the valid values.
|
|
</summary>
|
|
<value>
|
|
The valid values.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifIntegerEncoderParameter.ParameterType">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifStringEncoderParameter">
|
|
<summary>
|
|
Represents a string LibHeif encoder parameter
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.HeifEncoderParameter`1" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifStringEncoderParameter.#ctor(System.String,System.Boolean,System.String,System.Collections.ObjectModel.ReadOnlyCollection{System.String})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifStringEncoderParameter"/> class.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="hasDefaultValue"><see langword="true"/> if the parameter has a default value; otherwise, <see langword="false"/>.</param>
|
|
<param name="defaultValue">The default value.</param>
|
|
<param name="validValues">The valid values.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifStringEncoderParameter.ParameterType">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifStringEncoderParameter.ValidValues">
|
|
<summary>
|
|
Gets the valid values.
|
|
</summary>
|
|
<value>
|
|
The valid values.
|
|
</value>
|
|
</member>
|
|
<member name="T:LibHeifSharp.IHeifEncoderParameter">
|
|
<summary>
|
|
The interface that all LibHeif encoder parameters implement
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.IHeifEncoderParameter.Name">
|
|
<summary>
|
|
Gets the parameter name.
|
|
</summary>
|
|
<value>
|
|
The parameter name.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.IHeifEncoderParameter.ParameterType">
|
|
<summary>
|
|
Gets the type of the parameter.
|
|
</summary>
|
|
<value>
|
|
The type of the parameter.
|
|
</value>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifChannel">
|
|
<summary>
|
|
The LibHeif image channels
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChannel.Y">
|
|
<summary>
|
|
The Y channel in YCbCr.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChannel.Cb">
|
|
<summary>
|
|
The Cb channel in YCbCr.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChannel.Cr">
|
|
<summary>
|
|
The Cr channel in YCbCr.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChannel.R">
|
|
<summary>
|
|
The red channel in RGB and RGBA.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChannel.G">
|
|
<summary>
|
|
The green channel in RGB and RGBA.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChannel.B">
|
|
<summary>
|
|
The blue channel in RGB and RGBA.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChannel.Alpha">
|
|
<summary>
|
|
The alpha channel.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChannel.Interleaved">
|
|
<summary>
|
|
The image uses interleaved channels
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifChroma">
|
|
<summary>
|
|
The LibHeif image pixel format
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.Undefined">
|
|
<summary>
|
|
Undefined.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.Monochrome">
|
|
<summary>
|
|
Monochrome.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.Yuv420">
|
|
<summary>
|
|
YUV 4:2:0.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.Yuv422">
|
|
<summary>
|
|
YUV 4:2:2.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.Yuv444">
|
|
<summary>
|
|
YUV 4:4:4.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.InterleavedRgb24">
|
|
<summary>
|
|
An interleaved 24 bits-per-pixel RGB format. Each channel is allocated 8 bits.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.InterleavedRgba32">
|
|
<summary>
|
|
An interleaved 32 bits-per-pixel RGBA format. Each channel is allocated 8 bits.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.InterleavedRgb48BE">
|
|
<summary>
|
|
An interleaved 48 bits-per-pixel RGB format using big-endian byte order. Each channel is allocated 16 bits.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.InterleavedRgba64BE">
|
|
<summary>
|
|
An interleaved 64 bits-per-pixel RGBA format using big-endian byte order. Each channel is allocated 16 bits.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.InterleavedRgb48LE">
|
|
<summary>
|
|
An interleaved 48 bits-per-pixel RGB format using little-endian byte order. Each channel is allocated 16 bits.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChroma.InterleavedRgba64LE">
|
|
<summary>
|
|
An interleaved 64 bits-per-pixel RGBA format using little-endian byte order. Each channel is allocated 16 bits.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifChromaDownsamplingAlgorithm">
|
|
<summary>
|
|
The LibHeif chroma down-sampling algorithms.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.HeifColorConversionOptions"/>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChromaDownsamplingAlgorithm.NearestNeighbor">
|
|
<summary>
|
|
The nearest neighbor chroma down-sampling algorithm.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChromaDownsamplingAlgorithm.Average">
|
|
<summary>
|
|
The average chroma down-sampling algorithm.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChromaDownsamplingAlgorithm.SharpYuv">
|
|
<summary>
|
|
The sharp YUV chroma down-sampling algorithm.
|
|
</summary>
|
|
<remarks>
|
|
Makes edges look sharper when using YUV 420 with bilinear chroma up-sampling.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifChromaUpsamplingAlgorithm">
|
|
<summary>
|
|
The LibHeif chroma up-sampling algorithms.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.HeifColorConversionOptions"/>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChromaUpsamplingAlgorithm.NearestNeighbor">
|
|
<summary>
|
|
The nearest neighbor up-sampling algorithm.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifChromaUpsamplingAlgorithm.Bilinear">
|
|
<summary>
|
|
The bilinear up-sampling algorithm.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifColorConversionOptions">
|
|
<summary>
|
|
The LibHeif color conversion options.
|
|
</summary>
|
|
<seealso cref="P:LibHeifSharp.HeifDecodingOptions.ColorConversionOptions"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifColorConversionOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifColorConversionOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifColorConversionOptions.PreferredChromaDownsamplingAlgorithm">
|
|
<summary>
|
|
Gets or sets the preferred chroma down-sampling algorithm.
|
|
</summary>
|
|
<value>
|
|
The preferred chroma down-sampling algorithm.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifColorConversionOptions.PreferredChromaUpsamplingAlgorithm">
|
|
<summary>
|
|
Gets or sets the preferred chroma up-sampling algorithm.
|
|
</summary>
|
|
<value>
|
|
The preferred chroma up-sampling algorithm.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifColorConversionOptions.UseOnlyPreferredChromaAlgorithm">
|
|
<summary>
|
|
Gets or sets a value indicating whether only the preferred chroma algorithm should be used.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/>if only the preferred chroma algorithm should be used; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifColorspace">
|
|
<summary>
|
|
The color space of the image
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifColorspace.Undefined">
|
|
<summary>
|
|
The color space is not defined.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifColorspace.YCbCr">
|
|
<summary>
|
|
The color space is YCbCr.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifColorspace.Rgb">
|
|
<summary>
|
|
The color space is Rgb.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifColorspace.Monochrome">
|
|
<summary>
|
|
The color space is monochrome.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifCompressionFormat">
|
|
<summary>
|
|
The LibHeif compression format.
|
|
</summary>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.GetEncoder(LibHeifSharp.HeifCompressionFormat)"/>
|
|
<seealso cref="M:LibHeifSharp.LibHeifInfo.HaveDecoder(LibHeifSharp.HeifCompressionFormat)"/>
|
|
<seealso cref="M:LibHeifSharp.LibHeifInfo.HaveEncoder(LibHeifSharp.HeifCompressionFormat)"/>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Undefined">
|
|
<summary>
|
|
The compression format is not defined.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Hevc">
|
|
<summary>
|
|
The compression format is HEVC.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Avc">
|
|
<summary>
|
|
The compression format is AVC.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Jpeg">
|
|
<summary>
|
|
The compression format is JPEG.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Av1">
|
|
<summary>
|
|
The compression format is AV1.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Vvc">
|
|
<summary>
|
|
The compression format is VVC.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Evc">
|
|
<summary>
|
|
The compression format is EVC.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Jpeg2000">
|
|
<summary>
|
|
The compression format is JPEG 2000.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Uncompressed">
|
|
<summary>
|
|
The compression format is uncompressed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifCompressionFormat.Mask">
|
|
<summary>
|
|
The compression format is mask.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifContentLightLevel">
|
|
<summary>
|
|
Represents the Content Light Level values used by HDR images.
|
|
</summary>
|
|
<seealso cref="P:LibHeifSharp.HeifImage.ContentLightLevel"/>
|
|
<seealso cref="T:System.IEquatable`1" />
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContentLightLevel.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifContentLightLevel"/> class.
|
|
</summary>
|
|
<param name="maxContentLightLevel">
|
|
The maximum content light level in candelas per square meter.
|
|
A value of 0 indicates that the value is undefined.
|
|
</param>
|
|
<param name="maxPictureAverageLightLevel">
|
|
The maximum picture average light level in candelas per square meter.
|
|
A value of 0 indicates that the value is undefined.
|
|
</param>
|
|
<exception cref="T:System.ArgumentException">
|
|
Both <paramref name="maxContentLightLevel"/> and <paramref name="maxPictureAverageLightLevel"/> are zero.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="maxContentLightLevel"/> must be in the range of [0, 65535].
|
|
<paramref name="maxPictureAverageLightLevel"/> must be in the range of [0, 65535].
|
|
</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifContentLightLevel.MaxContentLightLevel">
|
|
<summary>
|
|
Gets the maximum content light level.
|
|
</summary>
|
|
<value>
|
|
The maximum content light level.
|
|
A value of 0 indicates that the value is undefined.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifContentLightLevel.MaxPictureAverageLightLevel">
|
|
<summary>
|
|
Gets the maximum picture average light level.
|
|
</summary>
|
|
<value>
|
|
The maximum picture average light level.
|
|
A value of 0 indicates that the value is undefined.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContentLightLevel.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContentLightLevel.Equals(LibHeifSharp.HeifContentLightLevel)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContentLightLevel.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContentLightLevel.op_Equality(LibHeifSharp.HeifContentLightLevel,LibHeifSharp.HeifContentLightLevel)">
|
|
<summary>
|
|
Implements the operator ==.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContentLightLevel.op_Inequality(LibHeifSharp.HeifContentLightLevel,LibHeifSharp.HeifContentLightLevel)">
|
|
<summary>
|
|
Implements the operator !=.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifContext">
|
|
<summary>
|
|
The LibHeif context.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.ResourceManagement.Disposable" />
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifContext"/> class.
|
|
</summary>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
Unable to create the native HeifContext.
|
|
|
|
-or-
|
|
|
|
The LibHeif version is not supported.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifContext"/> class, with the specified file to read from.
|
|
</summary>
|
|
<param name="path">The file to read from.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="path"/> is empty, contains only whitespace or contains invalid characters.
|
|
</exception>
|
|
<exception cref="T:System.IO.FileNotFoundException">The file specified by <paramref name="path"/> does not exist.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
Unable to create the native HeifContext.
|
|
|
|
-or-
|
|
|
|
The LibHeif version is not supported.
|
|
|
|
-or-
|
|
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
|
|
<exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
|
|
<exception cref="T:System.UnauthorizedAccessException">
|
|
The access requested is not permitted by the operating system for the specified path.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.#ctor(System.Byte[])">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifContext"/> class, with the specified byte array to read from.
|
|
</summary>
|
|
<param name="bytes">A byte array that contains the HEIF image.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="bytes"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="bytes"/> is empty.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
Unable to create the native HeifContext.
|
|
|
|
-or-
|
|
|
|
The LibHeif version is not supported.
|
|
|
|
-or-
|
|
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.#ctor(System.ReadOnlyMemory{System.Byte})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifContext"/> class, with the specified memory to read from.
|
|
</summary>
|
|
<param name="bytes">A sequence of bytes that contains the HEIF image.</param>
|
|
<exception cref="T:System.ArgumentException"><paramref name="bytes"/> is empty.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
Unable to create the native HeifContext.
|
|
|
|
-or-
|
|
|
|
The LibHeif version is not supported.
|
|
|
|
-or-
|
|
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.#ctor(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifContext"/> class with the specified stream to read from, and optionally leaves the stream open.
|
|
</summary>
|
|
<param name="stream">The stream to read from.</param>
|
|
<param name="leaveOpen">
|
|
<see langword="true"/> to leave the stream open after the <see cref="T:LibHeifSharp.HeifContext"/> object is disposed; otherwise, <see langword="false"/>.
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="stream"/> must support reading and seeking.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
Unable to create the native HeifContext.
|
|
|
|
-or-
|
|
|
|
The LibHeif version is not supported.
|
|
|
|
-or-
|
|
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifContext.ImageDecodeErrorDelegate">
|
|
<summary>
|
|
The error callback that is used when decoding the image.
|
|
</summary>
|
|
<param name="error">The error.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddExifMetadata(LibHeifSharp.HeifImageHandle,System.Byte[])">
|
|
<summary>
|
|
Adds EXIF meta-data to the image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<param name="exif">The EXIF data.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="exif"/> is null.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="exif"/> is empty.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddExifMetadata(LibHeifSharp.HeifImageHandle,System.ReadOnlySpan{System.Byte})">
|
|
<summary>
|
|
Adds EXIF meta-data to the image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<param name="exif">The EXIF data.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is null.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="exif"/> is empty.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddGenericMetadata(LibHeifSharp.HeifImageHandle,System.String,System.Byte[])">
|
|
<summary>
|
|
Adds generic meta-data to the image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<param name="type">The meta-data type.</param>
|
|
<param name="data">The generic meta-data.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="type"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="data"/> is null.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="type"/> is empty or contains only whitespace characters.
|
|
|
|
-or-
|
|
|
|
<paramref name="data"/> is empty.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddGenericMetadata(LibHeifSharp.HeifImageHandle,System.String,System.ReadOnlySpan{System.Byte})">
|
|
<summary>
|
|
Adds generic meta-data to the image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<param name="type">The meta-data type.</param>
|
|
<param name="data">The generic meta-data.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="type"/> is null.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="type"/> is empty or contains only whitespace characters.
|
|
|
|
-or-
|
|
|
|
<paramref name="data"/> is empty.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddGenericMetadata(LibHeifSharp.HeifImageHandle,System.String,System.String,System.Byte[])">
|
|
<summary>
|
|
Adds generic meta-data to the image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<param name="type">The meta-data type.</param>
|
|
<param name="contentType">The meta-data content type.</param>
|
|
<param name="data">The generic meta-data.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="type"/> is null.
|
|
-or-
|
|
|
|
<paramref name="data"/> is null.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="type"/> is empty or contains only whitespace characters.
|
|
|
|
-or-
|
|
|
|
<paramref name="contentType"/> is empty or contains only whitespace characters.
|
|
|
|
-or-
|
|
|
|
<paramref name="data"/> is empty.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddGenericMetadata(LibHeifSharp.HeifImageHandle,System.String,System.String,System.ReadOnlySpan{System.Byte})">
|
|
<summary>
|
|
Adds generic meta-data to the image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<param name="type">The meta-data type.</param>
|
|
<param name="contentType">The meta-data content type.</param>
|
|
<param name="data">The generic meta-data.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="type"/> is null.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="type"/> is empty or contains only whitespace characters.
|
|
|
|
-or-
|
|
|
|
<paramref name="contentType"/> is empty or contains only whitespace characters.
|
|
|
|
-or-
|
|
|
|
<paramref name="data"/> is empty.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddUserDescriptionProperty(LibHeifSharp.HeifItemId,LibHeifSharp.UserDescriptionProperty)">
|
|
<summary>
|
|
Adds an user description property to the specified item.
|
|
</summary>
|
|
<param name="itemId">The item identifier.</param>
|
|
<param name="userDescription">The user description property.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="userDescription"/> is <see langword="null"/>.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This method is supported starting with LibHeif version 1.16.0, it will throw an
|
|
exception on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddUserDescriptionProperty(LibHeifSharp.HeifImageHandle,LibHeifSharp.UserDescriptionProperty)">
|
|
<summary>
|
|
Adds an user description property to the specified image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<param name="userDescription">The user description.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is <see langword="null"/>.
|
|
-or-
|
|
<paramref name="userDescription"/> is <see langword="null"/>.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This method is supported starting with LibHeif version 1.16.0, it will throw an
|
|
exception on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddUserDescriptionProperty(LibHeifSharp.HeifRegionItem,LibHeifSharp.UserDescriptionProperty)">
|
|
<summary>
|
|
Adds an user description property to the specified region item.
|
|
</summary>
|
|
<param name="regionItem">The region item.</param>
|
|
<param name="userDescription">The user description.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="regionItem"/> is <see langword="null"/>.
|
|
-or-
|
|
<paramref name="userDescription"/> is <see langword="null"/>.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This method is supported starting with LibHeif version 1.16.0, it will throw an
|
|
exception on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddXmpMetadata(LibHeifSharp.HeifImageHandle,System.Byte[])">
|
|
<summary>
|
|
Adds XMP meta-data to the image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<param name="xmp">The XMP data.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="xmp"/> is null.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="xmp"/> is empty.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.AddXmpMetadata(LibHeifSharp.HeifImageHandle,System.ReadOnlySpan{System.Byte})">
|
|
<summary>
|
|
Adds XMP meta-data to the image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<param name="xmp">The XMP data.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="imageHandle"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="xmp"/> is empty.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.EncodeImage(LibHeifSharp.HeifImage,LibHeifSharp.HeifEncoder,LibHeifSharp.HeifEncodingOptions)">
|
|
<summary>
|
|
Encodes the image.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
<param name="encoder">The encoder.</param>
|
|
<param name="options">The encoder options.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="image"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="encoder"/> is null.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.EncodeImageAndReturnHandle(LibHeifSharp.HeifImage,LibHeifSharp.HeifEncoder,LibHeifSharp.HeifEncodingOptions)">
|
|
<summary>
|
|
Encodes the image and returns the resulting image handle.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
<param name="encoder">The encoder.</param>
|
|
<param name="options">The encoder options.</param>
|
|
<returns>The image handle.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="image"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="encoder"/> is null.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.EncodeThumbnail(System.Int32,LibHeifSharp.HeifImage,LibHeifSharp.HeifImageHandle,LibHeifSharp.HeifEncoder,LibHeifSharp.HeifEncodingOptions)">
|
|
<summary>
|
|
Encodes the image thumbnail.
|
|
</summary>
|
|
<param name="boundingBoxSize">The size of the thumbnail bounding box.</param>
|
|
<param name="thumbnail">The thumbnail image.</param>
|
|
<param name="parentImageHandle">The handle of the parent image that this thumbnail should be assigned to.</param>
|
|
<param name="encoder">The encoder.</param>
|
|
<param name="options">The encoder options.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="thumbnail" /> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="parentImageHandle" /> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="encoder" /> is null.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="boundingBoxSize"/> is less than or equal to zero.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetEncoderDescriptors(LibHeifSharp.HeifCompressionFormat,System.String)">
|
|
<summary>
|
|
Gets a list of the encoder descriptors.
|
|
</summary>
|
|
<param name="format">The compression format.</param>
|
|
<param name="nameFilter">The encoder name filter.</param>
|
|
<returns>The encoder descriptors.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetEncoder(LibHeifSharp.HeifCompressionFormat)">
|
|
<summary>
|
|
Gets the default encoder for the specified compression format.
|
|
</summary>
|
|
<param name="format">The compression format.</param>
|
|
<returns>The default encoder for the specified compression format.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetEncoder(LibHeifSharp.HeifEncoderDescriptor)">
|
|
<summary>
|
|
Gets the encoder associated with the specified encoder descriptor.
|
|
</summary>
|
|
<param name="encoderDescriptor">The encoder descriptor.</param>
|
|
<returns>The encoder associated with the specified encoder descriptor.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="encoderDescriptor"/> is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetImageHandle(LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Gets the image handle for the specified image id.
|
|
</summary>
|
|
<param name="imageId">The image id.</param>
|
|
<returns>The image handle for the specified image id.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.InvalidOperationException">A reader must be set before calling this method.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetPrimaryImageHandle">
|
|
<summary>
|
|
Gets the image handle for the primary image.
|
|
</summary>
|
|
<returns>The image handle for the primary image.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.InvalidOperationException">A reader must be set before calling this method.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetRegionItem(LibHeifSharp.HeifRegionItemId)">
|
|
<summary>
|
|
Gets the region item.
|
|
</summary>
|
|
<param name="id">The region item identifier.</param>
|
|
<returns>The region item.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetRegionItemIds"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetTopLevelImageIds">
|
|
<summary>
|
|
Gets a list of the top-level image ids.
|
|
</summary>
|
|
<returns>A list of the top-level image ids.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The file does not have any top-level images.
|
|
|
|
-or-
|
|
|
|
Could not get all of the top-level image ids.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">A reader must be set before calling this method.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetTransformationProperties(LibHeifSharp.HeifImageHandle)">
|
|
<summary>
|
|
Gets the transformation properties that should be applied to the specified image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<returns>The transformation properties that should be applied to the specified image.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is <see langword="null"/>.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This method is supported starting with LibHeif version 1.16.0, it will throw an
|
|
exception on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetUserDescriptionProperties(LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Gets the user description properties that are associated with the specified item.
|
|
</summary>
|
|
<param name="itemId">The item identifier.</param>
|
|
<returns>
|
|
A list of the user description properties that are associated with the specified item.
|
|
</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This method is supported starting with LibHeif version 1.16.0, it will throw an
|
|
exception on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetUserDescriptionProperties(LibHeifSharp.HeifImageHandle)">
|
|
<summary>
|
|
Gets the user description properties that are associated with the specified image.
|
|
</summary>
|
|
<param name="imageHandle">The image handle.</param>
|
|
<returns>
|
|
A list of the user description properties that are associated with the specified image.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="imageHandle"/> is <see langword="null"/>.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This method is supported starting with LibHeif version 1.16.0, it will throw an
|
|
exception on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.GetUserDescriptionProperties(LibHeifSharp.HeifRegionItem)">
|
|
<summary>
|
|
Gets the user description properties that are associated with the specified region item.
|
|
</summary>
|
|
<param name="regionItem">The region item.</param>
|
|
<returns>
|
|
A list of the user description properties that are associated with the specified region item.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="regionItem"/> is <see langword="null"/>.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This method is supported starting with LibHeif version 1.16.0, it will throw an
|
|
exception on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.ReadFromFile(System.String)">
|
|
<summary>
|
|
Reads the specified file into this instance.
|
|
</summary>
|
|
<param name="path">The file path.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="path"/> is empty, contains only whitespace or contains invalid characters.
|
|
</exception>
|
|
<exception cref="T:System.IO.FileNotFoundException">The file specified by <paramref name="path"/> does not exist.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
|
|
<exception cref="T:System.InvalidOperationException">This HeifContext already has an associated reader.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
|
|
<exception cref="T:System.UnauthorizedAccessException">
|
|
The access requested is not permitted by the operating system for the specified path.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.ReadFromMemory(System.Byte[])">
|
|
<summary>
|
|
Reads the specified byte array into this instance.
|
|
</summary>
|
|
<param name="bytes">The byte array.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="bytes"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="bytes"/> is empty.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.InvalidOperationException">This HeifContext already has an associated reader.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.SetMaximumDecodingThreads(System.Int32)">
|
|
<summary>
|
|
Sets the maximum number of threads that LibHeif can use for decoding images.
|
|
</summary>
|
|
<param name="maxDecodingThreads">The maximum number of threads that LibHeif can use for decoding images.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="maxDecodingThreads"/> is less than or equal to zero.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
<para>
|
|
This method allows callers to limit the number of threads that LibHeif can use when decoding images.
|
|
The value will replace the default limit that LibHeif uses when decoding images in this instance.
|
|
</para>
|
|
<para>
|
|
It is supported starting with LibHeif version 1.13.0, and will be ignored on older versions.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.SetMaximumImageSizeLimit(System.Int32)">
|
|
<summary>
|
|
Sets the maximum image size limit.
|
|
</summary>
|
|
<param name="maxImageSizeLimit">The maximum image size limit.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="maxImageSizeLimit"/> is less than or equal to zero.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This method allows callers to limit the maximum image width/height that LibHeif can load.
|
|
The value will replace the default limit that LibHeif uses when loading images in this instance.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.SetPrimaryImage(LibHeifSharp.HeifImageHandle)">
|
|
<summary>
|
|
Sets the primary image.
|
|
</summary>
|
|
<param name="primaryImage">The primary image.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="primaryImage"/> is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.WriteToFile(System.String)">
|
|
<summary>
|
|
Writes this instance to the specified file.
|
|
</summary>
|
|
<param name="path">The file path.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="path"/> is empty, contains only whitespace or contains invalid characters.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
|
|
<exception cref="T:System.UnauthorizedAccessException">
|
|
The access requested is not permitted by the operating system for the specified path.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.WriteToStream(System.IO.Stream)">
|
|
<summary>
|
|
Writes this instance to the specified stream.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="stream"/> must support writing.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases unmanaged and - optionally - managed resources.
|
|
</summary>
|
|
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.CreateNativeContext">
|
|
<summary>
|
|
Creates the native LibHeif context.
|
|
</summary>
|
|
<returns>The native LibHeif context.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">Unable to create the native HeifContext.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.HandleFileIOError(LibHeifSharp.IHeifIOError,LibHeifSharp.Interop.heif_error@,System.Boolean)">
|
|
<summary>
|
|
Handles the file IO error.
|
|
</summary>
|
|
<param name="heifIOError">The IO error.</param>
|
|
<param name="error">The error.</param>
|
|
<param name="wrapIOExceptions">
|
|
<see langword="true"/> if an IOException should be wrapped in a HeifException; otherwise, <see langword="false"/>.
|
|
</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">The exception that is thrown with the error details.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.EnsureReaderSet">
|
|
<summary>
|
|
Ensures that the reader has been set.
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">The reader has not been set.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.HandleFileReadError(LibHeifSharp.Interop.heif_error@)">
|
|
<summary>
|
|
Handles the file read error.
|
|
</summary>
|
|
<param name="error">The error.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">The exception that is thrown with the error details.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.InitializeContextFromReader">
|
|
<summary>
|
|
Initializes the native context from the current reader.
|
|
</summary>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifContext.WriteToStreamInternal(System.IO.Stream)">
|
|
<summary>
|
|
Writes the HeifContext to the specified stream.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifDecodedMasteringDisplayColourVolume">
|
|
<summary>
|
|
Represents the decoded HDR mastering display color volume.
|
|
</summary>
|
|
<seealso cref="M:LibHeifSharp.HeifMasteringDisplayColourVolume.Decode"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodedMasteringDisplayColourVolume.DisplayPrimariesX">
|
|
<summary>
|
|
The x chromaticity coordinates of the mastering display.
|
|
</summary>
|
|
<value>
|
|
The x chromaticity coordinates of the mastering display.
|
|
A value of 0.0 indicates that the value is undefined.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodedMasteringDisplayColourVolume.DisplayPrimariesY">
|
|
<summary>
|
|
The y chromaticity coordinates of the mastering display.
|
|
</summary>
|
|
<value>
|
|
The y chromaticity coordinates of the mastering display.
|
|
A value of 0.0 indicates that the value is undefined.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodedMasteringDisplayColourVolume.WhitePointX">
|
|
<summary>
|
|
The x chromaticity coordinate of the mastering display white point.
|
|
</summary>
|
|
<value>
|
|
The x chromaticity coordinate of the mastering display white point.
|
|
A value of 0.0 indicates that the value is undefined.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodedMasteringDisplayColourVolume.WhitePointY">
|
|
<summary>
|
|
The y chromaticity coordinate of the mastering display white point.
|
|
</summary>
|
|
<value>
|
|
The y chromaticity coordinate of the mastering display white point.
|
|
A value of 0.0 indicates that the value is undefined.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodedMasteringDisplayColourVolume.MaxDisplayMasteringLuminance">
|
|
<summary>
|
|
The nominal maximum display luminance of the mastering display.
|
|
</summary>
|
|
<value>
|
|
The nominal maximum display luminance of the mastering display.
|
|
A value of 0.0 indicates that the value is undefined.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodedMasteringDisplayColourVolume.MinDisplayMasteringLuminance">
|
|
<summary>
|
|
The nominal minimum display luminance of the mastering display.
|
|
</summary>
|
|
<value>
|
|
The nominal minimum display luminance of the mastering display.
|
|
A value of 0.0 indicates that the value is undefined.
|
|
</value>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifDecoderDescriptor">
|
|
<summary>
|
|
Represents a LibHeif decoder descriptor.
|
|
</summary>
|
|
<seealso cref="M:LibHeifSharp.LibHeifInfo.GetDecoderDescriptors(LibHeifSharp.HeifCompressionFormat)"/>
|
|
<threadsafety static="true" instance="true"/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecoderDescriptor.Name">
|
|
<summary>
|
|
Gets the decoder name.
|
|
</summary>
|
|
<value>
|
|
The decoder name.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecoderDescriptor.IdName">
|
|
<summary>
|
|
Gets the decoder id name.
|
|
</summary>
|
|
<value>
|
|
The decoder id name.
|
|
</value>
|
|
<seealso cref="P:LibHeifSharp.HeifDecodingOptions.DecoderId"/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifDecodingOptions">
|
|
<summary>
|
|
The options that can be set when decoding an image.
|
|
</summary>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.Decode(LibHeifSharp.HeifColorspace,LibHeifSharp.HeifChroma,LibHeifSharp.HeifDecodingOptions)"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifDecodingOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifDecodingOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodingOptions.IgnoreTransformations">
|
|
<summary>
|
|
Gets or sets a value indicating whether transformations are ignored when decoding the image.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if transformations are ignored when decoding the image; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodingOptions.ConvertHdrToEightBit">
|
|
<summary>
|
|
Gets or sets a value indicating whether high bit-depth images should be converted to 8-bits-per-channel.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if high bit-depth images should be converted to 8-bits-per-channel; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodingOptions.Strict">
|
|
<summary>
|
|
Gets or sets a value indicating whether an error is returned for invalid input.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if an error is returned for invalid input; otherwise, <see langword="false"/>.
|
|
</value>
|
|
<remarks>
|
|
This property is supported starting with LibHeif 1.13.0, it is ignored on earlier versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodingOptions.DecoderId">
|
|
<summary>
|
|
Gets or sets a value that identifies the decoder to use.
|
|
</summary>
|
|
<value>
|
|
One of the <see cref="P:LibHeifSharp.HeifDecoderDescriptor.IdName"/> values; otherwise, <see langword="null"/> to use the default decoder.
|
|
</value>
|
|
<remarks>
|
|
This property is supported starting with LibHeif 1.15.0, it is ignored on earlier versions.
|
|
</remarks>
|
|
<seealso cref="M:LibHeifSharp.LibHeifInfo.GetDecoderDescriptors(LibHeifSharp.HeifCompressionFormat)"/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDecodingOptions.ColorConversionOptions">
|
|
<summary>
|
|
Gets or sets the color conversion options.
|
|
</summary>
|
|
<value>
|
|
The color conversion options.
|
|
</value>
|
|
<exception cref="T:System.ArgumentNullException">Value is <see langword="null"/>.</exception>
|
|
<remarks>
|
|
This property is supported starting with LibHeif 1.16.0, it is ignored on earlier versions.
|
|
</remarks>
|
|
<seealso cref="T:LibHeifSharp.HeifColorConversionOptions"/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifDepthRepresentationType">
|
|
<summary>
|
|
The depth representation type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifDepthRepresentationType.UniformInverseZ">
|
|
<summary>
|
|
Uniform inverse Z.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifDepthRepresentationType.UniformDisparity">
|
|
<summary>
|
|
Uniform disparity.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifDepthRepresentationType.UniformZ">
|
|
<summary>
|
|
Uniform Z
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifDepthRepresentationType.NonuniformDisparity">
|
|
<summary>
|
|
Non-uniform disparity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifDepthRepresentationInfo">
|
|
<summary>
|
|
The depth representation information.
|
|
</summary>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifDepthRepresentationInfo.#ctor(LibHeifSharp.Interop.heif_depth_representation_info*)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifDepthRepresentationInfo"/> class.
|
|
</summary>
|
|
<param name="info">The depth representation information.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The non-linear representation model is larger than 2 GB.
|
|
</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDepthRepresentationInfo.ZNear">
|
|
<summary>
|
|
Gets the Z near.
|
|
</summary>
|
|
<value>
|
|
The z near.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDepthRepresentationInfo.ZFar">
|
|
<summary>
|
|
Gets the Z far.
|
|
</summary>
|
|
<value>
|
|
The Z far.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDepthRepresentationInfo.DMin">
|
|
<summary>
|
|
Gets the D minimum.
|
|
</summary>
|
|
<value>
|
|
The D minimum.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDepthRepresentationInfo.DMax">
|
|
<summary>
|
|
Gets the D maximum.
|
|
</summary>
|
|
<value>
|
|
The D maximum.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDepthRepresentationInfo.DepthRepresentationType">
|
|
<summary>
|
|
Gets the type of the depth representation.
|
|
</summary>
|
|
<value>
|
|
The type of the depth representation.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDepthRepresentationInfo.DisparityReferenceView">
|
|
<summary>
|
|
Gets the disparity reference view.
|
|
</summary>
|
|
<value>
|
|
The disparity reference view.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifDepthRepresentationInfo.NonlinearRepresentationModel">
|
|
<summary>
|
|
Gets the non-linear representation model.
|
|
</summary>
|
|
<value>
|
|
The non-linear representation model.
|
|
</value>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifEncoder">
|
|
<summary>
|
|
A LibHeif encoder instance
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.ResourceManagement.Disposable" />
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.#ctor(LibHeifSharp.Interop.SafeHeifEncoder)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifEncoder"/> class.
|
|
</summary>
|
|
<param name="encoder">The encoder.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoder.EncoderParameters">
|
|
<summary>
|
|
Gets a list of the supported encoder parameters.
|
|
</summary>
|
|
<value>
|
|
A list of the supported encoder parameters.
|
|
</value>
|
|
<exception cref="T:LibHeifSharp.HeifException">An error occurred when creating the encoder parameters list.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoder.SafeHeifEncoder">
|
|
<summary>
|
|
Gets the encoder handle.
|
|
</summary>
|
|
<value>
|
|
The encoder handle.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetLossyQuality(System.Int32)">
|
|
<summary>
|
|
Sets the encoder lossy quality.
|
|
</summary>
|
|
<param name="quality">The quality value.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="quality"/> must be in the range of [0, 100] inclusive.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetLossless(System.Boolean)">
|
|
<summary>
|
|
Sets the lossless compression support.
|
|
</summary>
|
|
<param name="lossless">
|
|
<see langword="true"/> if the encoder should use lossless compression; otherwise, <see langword="false"/>.
|
|
</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetParameter(LibHeifSharp.HeifBooleanEncoderParameter,System.Boolean)">
|
|
<summary>
|
|
Sets an encoder parameter.
|
|
</summary>
|
|
<param name="parameter">The parameter.</param>
|
|
<param name="value">The parameter value.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="parameter"/> is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetParameter(LibHeifSharp.HeifIntegerEncoderParameter,System.Int32)">
|
|
<summary>
|
|
Sets an encoder parameter.
|
|
</summary>
|
|
<param name="parameter">The parameter.</param>
|
|
<param name="value">The parameter value.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="parameter"/> is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetParameter(LibHeifSharp.HeifStringEncoderParameter,System.String)">
|
|
<summary>
|
|
Sets an encoder parameter.
|
|
</summary>
|
|
<param name="parameter">The parameter.</param>
|
|
<param name="value">The parameter value.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="parameter"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="value"/> is null.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetParameter(System.String,System.Boolean)">
|
|
<summary>
|
|
Sets an encoder parameter.
|
|
</summary>
|
|
<param name="name">The parameter name.</param>
|
|
<param name="value">The parameter value.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="name"/> is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetParameter(System.String,System.Int32)">
|
|
<summary>
|
|
Sets an encoder parameter.
|
|
</summary>
|
|
<param name="name">The parameter name.</param>
|
|
<param name="value">The parameter value.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="name"/> is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetParameter(System.String,System.String)">
|
|
<summary>
|
|
Sets an encoder parameter.
|
|
</summary>
|
|
<param name="name">The parameter name.</param>
|
|
<param name="value">The parameter value.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="name"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="value"/> is null.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
Unable to convert the parameter to the correct type.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases unmanaged and - optionally - managed resources.
|
|
</summary>
|
|
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.GetEncoderParameterList">
|
|
<summary>
|
|
Gets the encoder parameter list.
|
|
</summary>
|
|
<returns>The encoder parameter list.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">An error occurred when creating the encoder parameter.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.GetEncoderParameterTypes">
|
|
<summary>
|
|
Gets the encoder parameter type dictionary.
|
|
</summary>
|
|
<returns>The encoder parameter type dictionary.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">An error occurred when creating the encoder parameter.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetBooleanParameter(System.String,System.Boolean)">
|
|
<summary>
|
|
Sets a Boolean encoder parameter.
|
|
</summary>
|
|
<param name="name">The parameter name.</param>
|
|
<param name="value">The parameter value.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetIntegerParameter(System.String,System.Int32)">
|
|
<summary>
|
|
Sets an integer encoder parameter.
|
|
</summary>
|
|
<param name="name">The parameter name.</param>
|
|
<param name="value">The parameter value.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoder.SetStringParameter(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Sets a string encoder parameter.
|
|
</summary>
|
|
<param name="name">The parameter name.</param>
|
|
<param name="value">The parameter value.</param>
|
|
<param name="coerceParameterType">
|
|
<see langword="true"/> if the parameter should be coerced to the correct type; otherwise, <see langword="false"/>.
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="name"/> is null.
|
|
|
|
-or-
|
|
|
|
<paramref name="value"/> is null.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
Unable to convert the parameter to the correct type.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifEncoderDescriptor">
|
|
<summary>
|
|
Represents a LibHeif encoder descriptor.
|
|
</summary>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.GetEncoderDescriptors(LibHeifSharp.HeifCompressionFormat,System.String)"/>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.GetEncoder(LibHeifSharp.HeifEncoderDescriptor)"/>
|
|
<threadsafety static="true" instance="true"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncoderDescriptor.#ctor(LibHeifSharp.Interop.heif_encoder_descriptor)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifEncoderDescriptor"/> class.
|
|
</summary>
|
|
<param name="descriptor">The descriptor.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderDescriptor.Name">
|
|
<summary>
|
|
Gets the encoder name.
|
|
</summary>
|
|
<value>
|
|
The encoder name.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderDescriptor.IdName">
|
|
<summary>
|
|
Gets the encoder id name.
|
|
</summary>
|
|
<value>
|
|
The encoder id name.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderDescriptor.CompressionFormat">
|
|
<summary>
|
|
Gets the encoder compression format.
|
|
</summary>
|
|
<value>
|
|
The encoder compression format.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderDescriptor.SupportsLossyCompression">
|
|
<summary>
|
|
Gets a value indicating whether the encoder supports lossy compression.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if the encoder supports lossy compression; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderDescriptor.SupportsLosslessCompression">
|
|
<summary>
|
|
Gets a value indicating whether the encoder supports lossless compression.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if the encoder supports lossless compression; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncoderDescriptor.Descriptor">
|
|
<summary>
|
|
Gets the encoder descriptor.
|
|
</summary>
|
|
<value>
|
|
The encoder descriptor.
|
|
</value>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifEncodingOptions">
|
|
<summary>
|
|
The options that can be set when encoding an image.
|
|
</summary>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncodingOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifEncodingOptions"/> class.
|
|
</summary>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncodingOptions.SaveAlphaChannel">
|
|
<summary>
|
|
Gets or sets a value indicating whether the alpha channel should be saved.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if the alpha channel should be saved; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncodingOptions.CropWithImageGrid">
|
|
<summary>
|
|
Gets or sets a value indicating whether LibHeif should use an image grid for cropping.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if LibHeif should use an image grid for cropping; otherwise, <see langword="false"/>.
|
|
</value>
|
|
<remarks>
|
|
This value was added in LibHeif version 1.9.2, it will be ignored on older versions.
|
|
<para>It is used as a compatibility workaround for macOS.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncodingOptions.WriteTwoColorProfiles">
|
|
<summary>
|
|
Gets or sets a value indicating whether two color profiles will be written when both
|
|
ICC and NCLX profiles are available.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if two color profiles should be written; otherwise, <see langword="false"/>.
|
|
</value>
|
|
<remarks>
|
|
This value was added in LibHeif version 1.10.0, it will be ignored on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncodingOptions.WriteNclxColorProfile">
|
|
<summary>
|
|
Gets or sets a value indicating whether a NCLX color profile will be written.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if a NCLX color profile will be written; otherwise, <see langword="false"/>.
|
|
</value>
|
|
<remarks>
|
|
This value was added in LibHeif version 1.11.0, it will be ignored on older versions.
|
|
<para>
|
|
It is used as a compatibility workaround for some versions of macOS and iOS
|
|
that cannot read images with a NCLX color profile.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncodingOptions.ImageOrientation">
|
|
<summary>
|
|
Gets or sets a value describing the transformations that will be applied
|
|
to the decoded image before it is displayed.
|
|
</summary>
|
|
<value>
|
|
The transformations that will be applied to the decoded image before it is displayed.
|
|
</value>
|
|
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException">
|
|
Image orientation cannot be set because it does not use a valid value, as defined in
|
|
the <see cref="T:LibHeifSharp.HeifOrientation"/> enumeration.
|
|
</exception>
|
|
<remarks>
|
|
This value was added in LibHeif version 1.14.0, it will be ignored on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifEncodingOptions.ColorConversionOptions">
|
|
<summary>
|
|
Gets or sets the color conversion options.
|
|
</summary>
|
|
<value>
|
|
The color conversion options.
|
|
</value>
|
|
<exception cref="T:System.ArgumentNullException">Value is <see langword="null"/>.</exception>
|
|
<remarks>
|
|
This property is supported starting with LibHeif 1.16.0, it is ignored on earlier versions.
|
|
</remarks>
|
|
<seealso cref="T:LibHeifSharp.HeifColorConversionOptions"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifEncodingOptions.CreateEncodingOptions">
|
|
<summary>
|
|
Creates the encoding options.
|
|
</summary>
|
|
<returns>The encoding options.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">Unable to create the native HeifEncodingOptions.</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifException">
|
|
<summary>
|
|
The exception that is thrown for LibHeif errors.
|
|
</summary>
|
|
<seealso cref="T:System.Exception" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifException"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifException"/> class.
|
|
</summary>
|
|
<param name="message">The message that describes the error.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifException"/> class.
|
|
</summary>
|
|
<param name="message">The error message that explains the reason for the exception.</param>
|
|
<param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifImage">
|
|
<summary>
|
|
Represents a LibHeif image.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.ResourceManagement.Disposable"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImage.#ctor(System.Int32,System.Int32,LibHeifSharp.HeifColorspace,LibHeifSharp.HeifChroma)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifImage"/> class.
|
|
</summary>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<param name="colorspace">The color space.</param>
|
|
<param name="chroma">The chroma.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="width"/> is less than or equal to zero.
|
|
|
|
-or-
|
|
|
|
<paramref name="height"/> is less than or equal to zero.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The LibHeif version is not supported.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImage.#ctor(LibHeifSharp.Interop.SafeHeifImage,System.Int32,System.Int32,LibHeifSharp.HeifIccColorProfile,LibHeifSharp.HeifNclxColorProfile)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifImage" /> class.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<param name="imageHandleIccColorProfile">The image handle ICC color profile.</param>
|
|
<param name="imageHandleNclxColorProfile">The image handle NCLX color profile.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.Width">
|
|
<summary>
|
|
Gets the image width.
|
|
</summary>
|
|
<value>
|
|
The image width.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.Height">
|
|
<summary>
|
|
Gets the image height.
|
|
</summary>
|
|
<value>
|
|
The image height.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.Colorspace">
|
|
<summary>
|
|
Gets the image color space.
|
|
</summary>
|
|
<value>
|
|
The image color space.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.Chroma">
|
|
<summary>
|
|
Gets the image chroma.
|
|
</summary>
|
|
<value>
|
|
The image chroma.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.ColorProfile">
|
|
<summary>
|
|
Gets or sets the image color profile.
|
|
</summary>
|
|
<value>
|
|
The image color profile.
|
|
</value>
|
|
<exception cref="T:System.ArgumentNullException">Value is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The color profile type is not supported.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.IccColorProfile">
|
|
<summary>
|
|
Gets or sets the image ICC color profile.
|
|
</summary>
|
|
<value>
|
|
The image ICC color profile.
|
|
</value>
|
|
<exception cref="T:System.ArgumentNullException">Value is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The color profile type is not supported.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.NclxColorProfile">
|
|
<summary>
|
|
Gets or sets the image NCLX color profile.
|
|
</summary>
|
|
<value>
|
|
The image NCLX color profile.
|
|
</value>
|
|
<exception cref="T:System.ArgumentNullException">Value is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The color profile type is not supported.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.DecodingWarnings">
|
|
<summary>
|
|
Gets a collection of warnings that occurred when decoding the image.
|
|
</summary>
|
|
<value>
|
|
A collection of warnings that occurred when decoding the image.
|
|
</value>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This property is supported starting with LibHeif version 1.13.0, it will return an
|
|
empty collection on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.ContentLightLevel">
|
|
<summary>
|
|
Gets or sets the image HDR content light level.
|
|
</summary>
|
|
<value>
|
|
The HDR content light level.
|
|
</value>
|
|
<exception cref="T:System.ArgumentNullException">Value is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This property is supported starting with LibHeif version 1.15.0, it will return
|
|
<see langword="null"/> on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.MasteringDisplayColourVolume">
|
|
<summary>
|
|
Gets or sets the image HDR mastering display color volume.
|
|
</summary>
|
|
<value>
|
|
The HDR mastering display color volume.
|
|
</value>
|
|
<exception cref="T:System.ArgumentNullException">Value is null.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This property is supported starting with LibHeif version 1.15.0, it will return
|
|
<see langword="null"/> on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.PixelAspectRatio">
|
|
<summary>
|
|
Gets or sets the image pixel aspect ratio.
|
|
</summary>
|
|
<value>
|
|
The pixel aspect ratio.
|
|
</value>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This property is supported starting with LibHeif version 1.15.0, it will throw an
|
|
exception on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.HasAlphaChannel">
|
|
<summary>
|
|
Gets a value indicating whether the image has an alpha channel.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if the image has an alpha channel; otherwise, <see langword="false"/>.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.IsPremultipliedAlpha">
|
|
<summary>
|
|
Gets or sets a value indicating whether the alpha channel is premultiplied.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if the alpha channel is premultiplied; otherwise, <see langword="false"/>.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This property is supported starting with LibHeif 1.12.0, it is ignored on earlier versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImage.SafeHeifImage">
|
|
<summary>
|
|
Gets the image handle.
|
|
</summary>
|
|
<value>
|
|
The image handle.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImage.AddPlane(LibHeifSharp.HeifChannel,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Adds a plane to the image.
|
|
</summary>
|
|
<param name="channel">The channel.</param>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<param name="bitDepth">The bit depth.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="width"/> is less than or equal to zero.
|
|
|
|
-or-
|
|
|
|
<paramref name="height"/> is less than or equal to zero.
|
|
|
|
-or-
|
|
|
|
<paramref name="bitDepth"/> is less than or equal to zero.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImage.HasChannel(LibHeifSharp.HeifChannel)">
|
|
<summary>
|
|
Determines whether this image contains the specified channel.
|
|
</summary>
|
|
<param name="channel">The channel.</param>
|
|
<returns>
|
|
<see langword="true"/> this image contains the specified channel; otherwise, <see langword="false"/>.
|
|
</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImage.GetPlane(LibHeifSharp.HeifChannel)">
|
|
<summary>
|
|
Gets the image data for the specified plane.
|
|
</summary>
|
|
<param name="channel">The channel.</param>
|
|
<returns>The image plane data.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">The image does not contain the specified channel.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImage.ScaleImage(System.Int32,System.Int32)">
|
|
<summary>
|
|
Scales the image.
|
|
</summary>
|
|
<param name="newWidth">The new width.</param>
|
|
<param name="newHeight">The new height.</param>
|
|
<returns>The scaled image.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImage.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases unmanaged and - optionally - managed resources.
|
|
</summary>
|
|
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImage.GetDecodingWarningsWhileLocked(LibHeifSharp.Interop.SafeHeifImage)">
|
|
<summary>
|
|
Get the decoding warnings while locked.
|
|
</summary>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImage.UpdateCachedColorProfilesWhileLocked">
|
|
<summary>
|
|
Updates the cached color profiles while locked.
|
|
</summary>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The color profile type is not supported.
|
|
|
|
-or-
|
|
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifImageHandle">
|
|
<summary>
|
|
Represents a LibHeif image handle.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.ResourceManagement.Disposable" />
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.#ctor(LibHeifSharp.Interop.SafeHeifImageHandle,LibHeifSharp.HeifContext.ImageDecodeErrorDelegate)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifImageHandle"/> class.
|
|
</summary>
|
|
<param name="handle">The handle.</param>
|
|
<param name="decodeErrorHandler">The decode error handler.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="handle"/> is null.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.#ctor(LibHeifSharp.Interop.SafeHeifImageHandle,LibHeifSharp.HeifContext.ImageDecodeErrorDelegate,LibHeifSharp.AuxiliaryImageType)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifImageHandle"/> class.
|
|
</summary>
|
|
<param name="handle">The handle.</param>
|
|
<param name="decodeErrorHandler">The decode error handler.</param>
|
|
<param name="auxiliaryImageType">The auxiliary image type.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="handle"/> is null.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.Width">
|
|
<summary>
|
|
Gets the image width.
|
|
</summary>
|
|
<value>
|
|
The image width.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.Height">
|
|
<summary>
|
|
Gets the image height.
|
|
</summary>
|
|
<value>
|
|
The image height.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.BitDepth">
|
|
<summary>
|
|
Gets the image bit depth.
|
|
</summary>
|
|
<value>
|
|
The image bit depth.
|
|
</value>
|
|
<exception cref="T:LibHeifSharp.HeifException">The image has an undefined bit depth.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.AuxiliaryImageType">
|
|
<summary>
|
|
Gets the type of auxiliary image that this instance represents.
|
|
</summary>
|
|
<value>
|
|
The type of auxiliary image that this instance represents.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.HasAlphaChannel">
|
|
<summary>
|
|
Gets a value indicating whether this instance has an alpha channel.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if this instance has an alpha channel; otherwise, <see langword="false"/>.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.HasDepthImage">
|
|
<summary>
|
|
Gets a value indicating whether this instance has a depth image.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if this instance has a depth image; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.IsPremultipliedAlpha">
|
|
<summary>
|
|
Gets a value indicating whether the alpha channel is premultiplied.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if the alpha channel is premultiplied; otherwise, <see langword="false"/>.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This property is supported starting with LibHeif 1.12.0, it will return <see langword="false"/>
|
|
on earlier versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.IsPrimaryImage">
|
|
<summary>
|
|
Gets a value indicating whether this instance is the primary image.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if this instance is the primary image; otherwise, <see langword="false"/>.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.IccColorProfile">
|
|
<summary>
|
|
Gets the image handle ICC color profile.
|
|
</summary>
|
|
<value>
|
|
The image handle ICC color profile.
|
|
</value>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The color profile type is not supported.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.NclxColorProfile">
|
|
<summary>
|
|
Gets the image handle NCLX color profile.
|
|
</summary>
|
|
<value>
|
|
The image handle NCLX color profile.
|
|
</value>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The color profile type is not supported.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.SafeHeifImageHandle">
|
|
<summary>
|
|
Gets the image handle.
|
|
</summary>
|
|
<value>
|
|
The safe handle.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.UntransformedHeight">
|
|
<summary>
|
|
Gets the height of the image before transformations have been applied.
|
|
</summary>
|
|
<value>
|
|
The height of the image before transformations have been applied.
|
|
</value>
|
|
<exception cref="T:LibHeifSharp.HeifException">The ISPE height is undefined.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifImageHandle.UntransformedWidth">
|
|
<summary>
|
|
Gets the width of the image before transformations have been applied.
|
|
</summary>
|
|
<value>
|
|
The width of the image before transformations have been applied.
|
|
</value>
|
|
<exception cref="T:LibHeifSharp.HeifException">The ISPE width is undefined.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.AddRegion(System.Int64,System.Int64)">
|
|
<summary>
|
|
Adds a region to the image handle.
|
|
</summary>
|
|
<param name="referenceWidth">The reference width.</param>
|
|
<param name="referenceHeight">The reference height.</param>
|
|
<returns>
|
|
The region item.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="referenceWidth"/> must be in the range of [0, 4294967295].
|
|
-or-
|
|
<paramref name="referenceHeight"/> must be in the range of [0, 4294967295].
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.Decode(LibHeifSharp.HeifColorspace,LibHeifSharp.HeifChroma,LibHeifSharp.HeifDecodingOptions)">
|
|
<summary>
|
|
Decodes this instance to a <see cref="T:LibHeifSharp.HeifImage"/>.
|
|
</summary>
|
|
<param name="colorspace">The destination image color space.</param>
|
|
<param name="chroma">The chroma.</param>
|
|
<param name="options">The decoding options.</param>
|
|
<returns>The decoded image.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The color profile type is not supported.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetAuxiliaryImage(LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Gets the auxiliary image handle.
|
|
</summary>
|
|
<param name="id">The auxiliary image id.</param>
|
|
<returns>The auxiliary image handle.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetAuxiliaryImageIds"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetAuxiliaryImageIds">
|
|
<summary>
|
|
Gets a list of the auxiliary image ids.
|
|
</summary>
|
|
<returns>A list of the auxiliary image ids.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
<para>The alpha and/or depth images are omitted from this list.</para>
|
|
<para>
|
|
LibHeif will include the alpha image (if present) when you call <see cref="M:LibHeifSharp.HeifImageHandle.Decode(LibHeifSharp.HeifColorspace,LibHeifSharp.HeifChroma,LibHeifSharp.HeifDecodingOptions)"/>
|
|
with the <see cref="T:LibHeifSharp.HeifChroma"/> parameter set to one of the <c>InterleavedRgba</c> values.
|
|
</para>
|
|
<para>
|
|
To read the depth images use <see cref="M:LibHeifSharp.HeifImageHandle.GetDepthImageIds"/> to get a list of the depth image item ids and
|
|
<see cref="M:LibHeifSharp.HeifImageHandle.GetDepthImage(LibHeifSharp.HeifItemId)"/> to convert the item id to a <see cref="T:LibHeifSharp.HeifImageHandle"/>.
|
|
</para>
|
|
<para>
|
|
This method is supported starting with LibHeif version 1.11.0, it will return an empty collection on older versions.
|
|
</para>
|
|
</remarks>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetAuxiliaryImage(LibHeifSharp.HeifItemId)"/>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetAuxiliaryType"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetAuxiliaryType">
|
|
<summary>
|
|
Gets the type identifier for the auxiliary image.
|
|
</summary>
|
|
<returns>The type identifier for the auxiliary image.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetDepthImage(LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Gets the depth images.
|
|
</summary>
|
|
<param name="id">The depth image id.</param>
|
|
<returns>The depth image handle.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetDepthImageIds"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetDepthImageIds">
|
|
<summary>
|
|
Gets a list of the depth image ids.
|
|
</summary>
|
|
<returns>A list of the depth image ids.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetDepthImage(LibHeifSharp.HeifItemId)"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetDepthRepresentationInfo(LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Gets the depth representation information.
|
|
</summary>
|
|
<param name="id">The depth image id.</param>
|
|
<returns>The depth representation information.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The non-linear representation model is larger than 2 GB.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetExifMetadata">
|
|
<summary>
|
|
Gets the EXIF meta-data.
|
|
</summary>
|
|
<returns>The EXIF meta-data bytes.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The meta-data block is larger than 2 GB.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
If the image contains more than one EXIF block, this method will only return the first one.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetMetadata(LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Gets the meta-data bytes.
|
|
</summary>
|
|
<param name="id">The identifier.</param>
|
|
<returns>The meta-data bytes.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The meta-data block is larger than 2 GB.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetMetadataBlockIds(System.String,System.String)"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetMetadata(LibHeifSharp.HeifMetadataBlockInfo)">
|
|
<summary>
|
|
Gets the meta-data bytes.
|
|
</summary>
|
|
<param name="info">The meta-data block information.</param>
|
|
<returns>The meta-data bytes.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="info"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetMetadataBlockInfo(LibHeifSharp.HeifItemId)"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetMetadataBlockInfo(LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Gets the meta-data information.
|
|
</summary>
|
|
<param name="id">The identifier.</param>
|
|
<returns>The meta-data information.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The meta-data block is larger than 2 GB.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetMetadataBlockIds(System.String,System.String)"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetMetadataBlockIds(System.String,System.String)">
|
|
<summary>
|
|
Gets a list of the meta-data block ids.
|
|
</summary>
|
|
<param name="type">The meta-data block type.</param>
|
|
<param name="contentType">The meta-data block content type.</param>
|
|
<returns>A list of the meta-data block ids.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">Could not get all of the meta-data block ids.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetMetadata(LibHeifSharp.HeifItemId)"/>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetMetadataBlockInfo(LibHeifSharp.HeifItemId)"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetRegionItemIds">
|
|
<summary>
|
|
Gets a list of the region item ids.
|
|
</summary>
|
|
<returns>A list of the region item ids.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">Could not get all of the region item ids.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<remarks>
|
|
This method is supported starting with LibHeif version 1.16.0, it will return an empty collection on older versions.
|
|
</remarks>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.GetRegionItem(LibHeifSharp.HeifRegionItemId)"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetThumbnailImage(LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Gets the thumbnail image handle.
|
|
</summary>
|
|
<param name="id">The thumbnail image id.</param>
|
|
<returns>The thumbnail image handle.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetThumbnailImageIds"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetThumbnailImageIds">
|
|
<summary>
|
|
Gets a list of the thumbnail image ids.
|
|
</summary>
|
|
<returns>A list of the thumbnail image ids.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">Could not get all of the thumbnail image ids.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetThumbnailImage(LibHeifSharp.HeifItemId)"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetXmpMetadata">
|
|
<summary>
|
|
Gets the XMP meta-data.
|
|
</summary>
|
|
<returns>The XMP meta-data bytes.</returns>
|
|
<remarks>
|
|
If the image contains more than one XMP block, this method will only return the first one.
|
|
</remarks>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
|
|
-or-
|
|
|
|
The meta-data block is larger than 2 GB.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.GetItemId">
|
|
<summary>
|
|
Gets the item identifier.
|
|
</summary>
|
|
<returns>The item identifier.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">This method requires LibHeif version 1.16.0 or later.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases unmanaged and - optionally - managed resources.
|
|
</summary>
|
|
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifImageHandle.CacheColorProfilesWhileLocked">
|
|
<summary>
|
|
Caches the image handle color profiles.
|
|
</summary>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The color profile type is not supported.
|
|
|
|
-or-
|
|
|
|
A LibHeif error occurred.
|
|
</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifItemId">
|
|
<summary>
|
|
Represents a LibHeif item id.
|
|
</summary>
|
|
<threadsafety static="true" instance="true"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifItemId.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the specified <see cref="T:System.Object" />, is equal to this instance.
|
|
</summary>
|
|
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
|
<returns>
|
|
<see langword="true"/> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <see langword="false"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifItemId.Equals(LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Indicates whether the current object is equal to another object of the same type.
|
|
</summary>
|
|
<param name="other">An object to compare with this object.</param>
|
|
<returns>
|
|
<see langword="true"/> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifItemId.GetHashCode">
|
|
<summary>
|
|
Returns a hash code for this instance.
|
|
</summary>
|
|
<returns>
|
|
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifItemId.ToString">
|
|
<summary>
|
|
Converts the numeric value of this instance to its equivalent string representation.
|
|
</summary>
|
|
<returns>
|
|
The string representation of the value of this instance, consisting of a sequence
|
|
of digits ranging from 0 to 9, without a sign or leading zeros.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifItemId.op_Equality(LibHeifSharp.HeifItemId,LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Implements the operator ==.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifItemId.op_Inequality(LibHeifSharp.HeifItemId,LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Implements the operator !=.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifMasteringDisplayColourVolume">
|
|
<summary>
|
|
Represents the HDR mastering display color volume.
|
|
</summary>
|
|
<seealso cref="P:LibHeifSharp.HeifImage.MasteringDisplayColourVolume"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifMasteringDisplayColourVolume.#ctor(System.Collections.Generic.IReadOnlyList{System.Int32},System.Collections.Generic.IReadOnlyList{System.Int32},System.Int32,System.Int32,System.Int64,System.Int64)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifMasteringDisplayColourVolume" /> class.
|
|
</summary>
|
|
<param name="displayPrimariesX">The display primaries x.</param>
|
|
<param name="displayPrimariesY">The display primaries y.</param>
|
|
<param name="whitePointX">The white point x.</param>
|
|
<param name="whitePointY">The white point y.</param>
|
|
<param name="maxDisplayMasteringLuminance">The maximum display mastering luminance.</param>
|
|
<param name="minDisplayMasteringLuminance">The minimum display mastering luminance.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="displayPrimariesX"/> is <see langword="null"/>.
|
|
|
|
-or-
|
|
|
|
<paramref name="displayPrimariesY"/> is <see langword="null"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="displayPrimariesX"/> count does not equal 3.
|
|
|
|
-or-
|
|
|
|
<paramref name="displayPrimariesY"/> count does not equal 3.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="whitePointX"/> must be in the range of [0, 65535].
|
|
|
|
-or-
|
|
|
|
<paramref name="whitePointY"/> must be in the range of [0, 65535].
|
|
|
|
-or-
|
|
|
|
<paramref name="maxDisplayMasteringLuminance"/> must be in the range of [0, 4294967295].
|
|
|
|
-or-
|
|
|
|
<paramref name="minDisplayMasteringLuminance"/> must be in the range of [0, 4294967295].
|
|
</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMasteringDisplayColourVolume.DisplayPrimariesX">
|
|
<summary>
|
|
The x chromaticity coordinates of the mastering display.
|
|
</summary>
|
|
<value>
|
|
The x chromaticity coordinates of the mastering display.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMasteringDisplayColourVolume.DisplayPrimariesY">
|
|
<summary>
|
|
The y chromaticity coordinates of the mastering display.
|
|
</summary>
|
|
<value>
|
|
The y chromaticity coordinates of the mastering display.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMasteringDisplayColourVolume.WhitePointX">
|
|
<summary>
|
|
The x chromaticity coordinate of the mastering display white point.
|
|
</summary>
|
|
<value>
|
|
The x chromaticity coordinate of the mastering display white point.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMasteringDisplayColourVolume.WhitePointY">
|
|
<summary>
|
|
The y chromaticity coordinate of the mastering display white point.
|
|
</summary>
|
|
<value>
|
|
The y chromaticity coordinate of the mastering display white point.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMasteringDisplayColourVolume.MaxDisplayMasteringLuminance">
|
|
<summary>
|
|
The nominal maximum display luminance of the mastering display.
|
|
</summary>
|
|
<value>
|
|
The nominal maximum display luminance of the mastering display.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMasteringDisplayColourVolume.MinDisplayMasteringLuminance">
|
|
<summary>
|
|
The nominal minimum display luminance of the mastering display.
|
|
</summary>
|
|
<value>
|
|
The nominal minimum display luminance of the mastering display.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifMasteringDisplayColourVolume.Decode">
|
|
<summary>
|
|
Decodes this instance.
|
|
</summary>
|
|
<returns>
|
|
A new <see cref="T:LibHeifSharp.HeifDecodedMasteringDisplayColourVolume"/> instance.
|
|
</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifMetadataBlockInfo">
|
|
<summary>
|
|
Represents the type information of a meta-data item.
|
|
</summary>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.GetMetadataBlockInfo(LibHeifSharp.HeifItemId)"/>
|
|
<threadsafety static="true" instance="true"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifMetadataBlockInfo.#ctor(LibHeifSharp.HeifItemId,System.String,System.String,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifMetadataBlockInfo"/> class.
|
|
</summary>
|
|
<param name="id">The item identifier.</param>
|
|
<param name="itemType">The item type.</param>
|
|
<param name="contentType">The item content type.</param>
|
|
<param name="size">The item size in bytes.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMetadataBlockInfo.Id">
|
|
<summary>
|
|
Gets the meta-data item identifier.
|
|
</summary>
|
|
<value>
|
|
The meta-data item identifier.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMetadataBlockInfo.ItemType">
|
|
<summary>
|
|
Gets a string describing the meta-data item type.
|
|
</summary>
|
|
<value>
|
|
The meta-data item type.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMetadataBlockInfo.ContentType">
|
|
<summary>
|
|
Gets a string describing the meta-data content type.
|
|
</summary>
|
|
<value>
|
|
The meta-data content type.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifMetadataBlockInfo.Size">
|
|
<summary>
|
|
Gets the size in bytes of the meta-data block.
|
|
</summary>
|
|
<value>
|
|
The size in bytes of the meta-data block.
|
|
</value>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifOrientation">
|
|
<summary>
|
|
Specifies how the decoder should transform the image before it is displayed.
|
|
</summary>
|
|
<remarks>
|
|
These values match the EXIF Orientation tag.
|
|
</remarks>
|
|
<seealso cref="P:LibHeifSharp.HeifEncodingOptions.ImageOrientation"/>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifOrientation.Normal">
|
|
<summary>
|
|
The image will not be rotated or flipped.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifOrientation.FlipHorizontally">
|
|
<summary>
|
|
The image will be flipped horizontally.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifOrientation.Rotate180">
|
|
<summary>
|
|
The image will be rotated 180 degrees.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifOrientation.FlipVertically">
|
|
<summary>
|
|
The image will be flipped vertically
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifOrientation.Rotate90ClockwiseThenFlipHorizontally">
|
|
<summary>
|
|
The image will be rotated 90 degrees clockwise followed by a horizontal flip.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifOrientation.Rotate90Clockwise">
|
|
<summary>
|
|
The image will be rotated 90 degrees clockwise.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifOrientation.Rotate90ClockwiseThenFlipVertically">
|
|
<summary>
|
|
The image will be rotated 90 degrees clockwise followed by a vertical flip.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.HeifOrientation.Rotate270Clockwise">
|
|
<summary>
|
|
The image will be rotated 270 degrees clockwise.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifPixelAspectRatio">
|
|
<summary>
|
|
Represents the pixel aspect ratio of an image
|
|
</summary>
|
|
<seealso cref="P:LibHeifSharp.HeifImage.PixelAspectRatio"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPixelAspectRatio.#ctor(System.Int64,System.Int64)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifPixelAspectRatio"/> class.
|
|
</summary>
|
|
<param name="horizontalSpacing">The horizontal spacing.</param>
|
|
<param name="verticalSpacing">The vertical spacing.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="verticalSpacing"/> must be in the range of [1, 4294967295].
|
|
|
|
-or-
|
|
|
|
<paramref name="verticalSpacing"/> must be in the range of [1, 4294967295].
|
|
</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifPixelAspectRatio.HorizontalSpacing">
|
|
<summary>
|
|
Gets the relative width of a pixel.
|
|
</summary>
|
|
<value>
|
|
The relative width of a pixel.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifPixelAspectRatio.VerticalSpacing">
|
|
<summary>
|
|
Gets the relative height of a pixel.
|
|
</summary>
|
|
<value>
|
|
The relative height of a pixel.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifPixelAspectRatio.HasSquareAspectRatio">
|
|
<summary>
|
|
Gets a value indicating whether this instance has a square aspect ratio.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if this instance has a square aspect ratio;
|
|
otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPixelAspectRatio.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPixelAspectRatio.Equals(LibHeifSharp.HeifPixelAspectRatio)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPixelAspectRatio.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPixelAspectRatio.op_Equality(LibHeifSharp.HeifPixelAspectRatio,LibHeifSharp.HeifPixelAspectRatio)">
|
|
<summary>
|
|
Implements the operator ==.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPixelAspectRatio.op_Inequality(LibHeifSharp.HeifPixelAspectRatio,LibHeifSharp.HeifPixelAspectRatio)">
|
|
<summary>
|
|
Implements the operator !=.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPixelAspectRatio.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifPlaneData">
|
|
<summary>
|
|
The data for an image plane.
|
|
</summary>
|
|
<threadsafety static="true" instance="true"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPlaneData.#ctor(System.Int32,System.Int32,System.Int32,LibHeifSharp.HeifChannel,System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifPlaneData"/> class.
|
|
</summary>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<param name="stride">The stride.</param>
|
|
<param name="channel">The channel.</param>
|
|
<param name="scan0">The starting address of the image data.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifPlaneData.Width">
|
|
<summary>
|
|
Gets the plane width.
|
|
</summary>
|
|
<value>
|
|
The width.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifPlaneData.Height">
|
|
<summary>
|
|
Gets the plane height.
|
|
</summary>
|
|
<value>
|
|
The height.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifPlaneData.Stride">
|
|
<summary>
|
|
Gets the plane stride, the width of a single row of pixels.
|
|
</summary>
|
|
<value>
|
|
The plane stride, in bytes.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifPlaneData.Channel">
|
|
<summary>
|
|
Gets the image channel.
|
|
</summary>
|
|
<value>
|
|
The image channel.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifPlaneData.Scan0">
|
|
<summary>
|
|
Gets the starting address of the image plane data.
|
|
</summary>
|
|
<value>
|
|
The starting address of the image plane data.
|
|
</value>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifPropertyId">
|
|
<summary>
|
|
Represents a LibHeif property id.
|
|
</summary>
|
|
<threadsafety static="true" instance="true"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPropertyId.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the specified <see cref="T:System.Object" />, is equal to this instance.
|
|
</summary>
|
|
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
|
<returns>
|
|
<see langword="true"/> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <see langword="false"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPropertyId.Equals(LibHeifSharp.HeifPropertyId)">
|
|
<summary>
|
|
Indicates whether the current object is equal to another object of the same type.
|
|
</summary>
|
|
<param name="other">An object to compare with this object.</param>
|
|
<returns>
|
|
<see langword="true"/> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPropertyId.GetHashCode">
|
|
<summary>
|
|
Returns a hash code for this instance.
|
|
</summary>
|
|
<returns>
|
|
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPropertyId.ToString">
|
|
<summary>
|
|
Converts the numeric value of this instance to its equivalent string representation.
|
|
</summary>
|
|
<returns>
|
|
The string representation of the value of this instance, consisting of a sequence
|
|
of digits ranging from 0 to 9, without a sign or leading zeros.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPropertyId.op_Equality(LibHeifSharp.HeifPropertyId,LibHeifSharp.HeifPropertyId)">
|
|
<summary>
|
|
Implements the operator ==.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifPropertyId.op_Inequality(LibHeifSharp.HeifPropertyId,LibHeifSharp.HeifPropertyId)">
|
|
<summary>
|
|
Implements the operator !=.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifRegionItemId">
|
|
<summary>
|
|
Represents a LibHeif region item id.
|
|
</summary>
|
|
<threadsafety static="true" instance="true"/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifRegionItemId.ImageHandleId">
|
|
<summary>
|
|
Gets the image handle identifier that is associated with this region item.
|
|
</summary>
|
|
<value>
|
|
The image handle identifier.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifRegionItemId.RegionItemId">
|
|
<summary>
|
|
Gets the region item identifier.
|
|
</summary>
|
|
<value>
|
|
The region item identifier.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItemId.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItemId.Equals(LibHeifSharp.HeifRegionItemId)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItemId.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItemId.op_Equality(LibHeifSharp.HeifRegionItemId,LibHeifSharp.HeifRegionItemId)">
|
|
<summary>
|
|
Implements the operator ==.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItemId.op_Inequality(LibHeifSharp.HeifRegionItemId,LibHeifSharp.HeifRegionItemId)">
|
|
<summary>
|
|
Implements the operator !=.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifByteArrayReader.#ctor(System.Byte[])">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifByteArrayReader"/> class.
|
|
</summary>
|
|
<param name="buffer">The buffer.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is null.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifByteArrayReader.#ctor(System.ArraySegment{System.Byte})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifByteArrayReader"/> class.
|
|
</summary>
|
|
<param name="buffer">The buffer.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifByteArrayReader.#ctor(System.ReadOnlyMemory{System.Byte})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifByteArrayReader"/> class.
|
|
</summary>
|
|
<param name="buffer">The buffer.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifReaderFactory.CreateFromFile(System.String)">
|
|
<summary>
|
|
Creates a <see cref="T:LibHeifSharp.HeifReader" /> instance from the specified file.
|
|
</summary>
|
|
<param name="path">The path.</param>
|
|
<returns>
|
|
The created <see cref="T:LibHeifSharp.HeifReader" /> instance.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is null.</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="path" /> is empty, contains only whitespace or contains invalid characters.</exception>
|
|
<exception cref="T:System.IO.FileNotFoundException">The file specified by <paramref name="path" /> does not exist.</exception>
|
|
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
|
|
<exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
|
|
<exception cref="T:System.UnauthorizedAccessException">The access requested is not permitted by the operating system for the specified path.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifReaderFactory.CreateFromMemory(System.Byte[])">
|
|
<summary>
|
|
Creates a <see cref="T:LibHeifSharp.HeifReader"/> instance from the specified byte array.
|
|
</summary>
|
|
<param name="bytes">The byte array.</param>
|
|
<returns>The created <see cref="T:LibHeifSharp.HeifReader"/> instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="bytes"/> is null.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifReaderFactory.CreateFromMemory(System.ReadOnlyMemory{System.Byte})">
|
|
<summary>
|
|
Creates a <see cref="T:LibHeifSharp.HeifReader"/> instance from the specified <see cref="T:System.ReadOnlyMemory`1"/>.
|
|
</summary>
|
|
<param name="bytes">The bytes.</param>
|
|
<returns>The created <see cref="T:LibHeifSharp.HeifReader"/> instance.</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifReaderFactory.CreateFromStream(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Creates a <see cref="T:LibHeifSharp.HeifReader"/> instance from the specified stream, and optionally takes ownership of the stream.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="ownsStream"><see langword="true"/> if the writer owns the stream; otherwise, <see langword="false"/>.</param>
|
|
<returns>The created <see cref="T:LibHeifSharp.HeifReader"/> instance.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
|
|
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifReaderFactory.CopyStreamToByteArray(System.IO.Stream)">
|
|
<summary>
|
|
Copies the stream to byte array.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<returns>A byte array containing the stream data.</returns>
|
|
<exception cref="T:System.IO.IOException">An I/O error occurred.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifStreamReader.#ctor(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifStreamReader"/> class.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="ownsStream"><see langword="true"/> if the writer owns the stream; otherwise, <see langword="false"/>.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifStreamWriter.#ctor(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.HeifStreamWriter"/> class.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="ownsStream"><see langword="true"/> if the writer owns the stream; otherwise, <see langword="false"/>.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.CropTransformationProperty">
|
|
<summary>
|
|
The crop transformation property.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.TransformationProperty"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.CropTransformationProperty.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.CropTransformationProperty"/> class.
|
|
</summary>
|
|
<param name="left">The left edge of the crop rectangle.</param>
|
|
<param name="top">The top edge of the crop rectangle.</param>
|
|
<param name="right">The right edge of the crop rectangle.</param>
|
|
<param name="bottom">The bottom edge of the crop rectangle.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.CropTransformationProperty.Left">
|
|
<summary>
|
|
Gets the left edge of the crop rectangle.
|
|
</summary>
|
|
<value>
|
|
The left edge of the crop rectangle.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.CropTransformationProperty.Top">
|
|
<summary>
|
|
Gets the top edge of the crop rectangle.
|
|
</summary>
|
|
<value>
|
|
The top edge of the crop rectangle.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.CropTransformationProperty.Right">
|
|
<summary>
|
|
Gets the right edge of the crop rectangle.
|
|
</summary>
|
|
<value>
|
|
The right edge of the crop rectangle.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.CropTransformationProperty.Bottom">
|
|
<summary>
|
|
Gets the bottom edge of the crop rectangle.
|
|
</summary>
|
|
<value>
|
|
The bottom edge of the crop rectangle.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.CropTransformationProperty.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.MirrorDirection">
|
|
<summary>
|
|
The direction that the image should be mirrored (flipped).
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MirrorDirection.Vertical">
|
|
<summary>
|
|
The image should be flipped vertically.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.MirrorDirection.Horizontal">
|
|
<summary>
|
|
The image should be flipped horizontally.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.MirrorTransformationProperty">
|
|
<summary>
|
|
The mirror transformation property.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.TransformationProperty"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.MirrorTransformationProperty.#ctor(LibHeifSharp.MirrorDirection)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.MirrorTransformationProperty"/> class.
|
|
</summary>
|
|
<param name="direction">The mirror direction.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.MirrorTransformationProperty.Direction">
|
|
<summary>
|
|
Gets the mirror direction.
|
|
</summary>
|
|
<value>
|
|
The mirror direction.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.MirrorTransformationProperty.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RotationTransformationProperty">
|
|
<summary>
|
|
The rotation transformation property.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.TransformationProperty"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RotationTransformationProperty.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.RotationTransformationProperty"/> class.
|
|
</summary>
|
|
<param name="rotationAngle">The rotation angle.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">Unsupported rotation angle: {rotationAngle} degrees.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RotationTransformationProperty.Rotation">
|
|
<summary>
|
|
Gets the rotation that the image requires.
|
|
</summary>
|
|
<value>
|
|
The rotation that the image requires.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RotationTransformationProperty.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RotationType">
|
|
<summary>
|
|
The type of rotation than the image requires.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RotationType.None">
|
|
<summary>
|
|
The image should not be rotated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RotationType.Rotate90DegreesCounterClockwise">
|
|
<summary>
|
|
The image should be rotated 90 degrees counter-clockwise.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RotationType.Rotate180Degrees">
|
|
<summary>
|
|
The image should be rotated 180 degrees.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RotationType.Rotate270DegreesCounterClockwise">
|
|
<summary>
|
|
The image should be rotated 270 degrees counter-clockwise.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransformationProperty">
|
|
<summary>
|
|
The base class for the image transformation properties.
|
|
</summary>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.GetTransformationProperties(LibHeifSharp.HeifImageHandle)"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformationProperty.Type">
|
|
<summary>
|
|
Gets the type of transformation.
|
|
</summary>
|
|
<value>
|
|
The type of transformation.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformationProperty.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransformationPropertyType">
|
|
<summary>
|
|
The type of image transformation that a property represents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransformationPropertyType.Mirror">
|
|
<summary>
|
|
The image mirroring transformation property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransformationPropertyType.Rotation">
|
|
<summary>
|
|
The image rotation transformation property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.TransformationPropertyType.Crop">
|
|
<summary>
|
|
The image cropping transformation property.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.UserDescriptionProperty">
|
|
<summary>
|
|
The user description property
|
|
</summary>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.AddUserDescriptionProperty(LibHeifSharp.HeifItemId,LibHeifSharp.UserDescriptionProperty)"/>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.AddUserDescriptionProperty(LibHeifSharp.HeifImageHandle,LibHeifSharp.UserDescriptionProperty)"/>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.AddUserDescriptionProperty(LibHeifSharp.HeifRegionItem,LibHeifSharp.UserDescriptionProperty)"/>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.GetUserDescriptionProperties(LibHeifSharp.HeifItemId)"/>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.GetUserDescriptionProperties(LibHeifSharp.HeifImageHandle)"/>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.GetUserDescriptionProperties(LibHeifSharp.HeifRegionItem)"/>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.UserDescriptionProperty.#ctor(System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.UserDescriptionProperty"/> class.
|
|
</summary>
|
|
<param name="description">The description.</param>
|
|
<param name="language">The language.</param>
|
|
<param name="name">The name.</param>
|
|
<param name="tags">The tags.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.UserDescriptionProperty.#ctor(LibHeifSharp.Interop.heif_property_user_description*)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.UserDescriptionProperty"/> class.
|
|
</summary>
|
|
<param name="native">The native structure.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The string contains characters that are not valid for the encoding.
|
|
</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.UserDescriptionProperty.Description">
|
|
<summary>
|
|
Gets the description.
|
|
</summary>
|
|
<value>
|
|
The description.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.UserDescriptionProperty.Language">
|
|
<summary>
|
|
Gets the language.
|
|
</summary>
|
|
<value>
|
|
The language.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.UserDescriptionProperty.Name">
|
|
<summary>
|
|
Gets the name.
|
|
</summary>
|
|
<value>
|
|
The name.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.UserDescriptionProperty.Tags">
|
|
<summary>
|
|
Gets the tags.
|
|
</summary>
|
|
<value>
|
|
The tags.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.UserDescriptionProperty.ToNative">
|
|
<summary>
|
|
Converts the data to its native format.
|
|
</summary>
|
|
<returns>A class containing the converted data.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The string contains characters that are not valid for the encoding.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.UserDescriptionProperty.NativeData.CreateNativeStructure">
|
|
<summary>
|
|
Creates the native structure.
|
|
</summary>
|
|
<returns>The native structure.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.UserDescriptionProperty.StringMarshaling.FromNative(System.IntPtr)">
|
|
<summary>
|
|
Create a managed string from the specified unmanaged string pointer.
|
|
</summary>
|
|
<param name="nativeString">The native string.</param>
|
|
<returns>The converted string.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The string contains characters that are not valid for the encoding.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.UserDescriptionProperty.StringMarshaling.ToNative(System.String)">
|
|
<summary>
|
|
Converts the string to its unmanaged format.
|
|
</summary>
|
|
<param name="value">The string to convert.</param>
|
|
<returns>A <see cref="T:LibHeifSharp.Interop.SafeCoTaskMemHandle"/> containing the unmanaged memory.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The string contains characters that are not valid for the encoding.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.UserDescriptionProperty.StringMarshaling.GetNativeStringLength(System.IntPtr)">
|
|
<summary>
|
|
Gets the length in bytes of the native string.
|
|
</summary>
|
|
<param name="nativeString">The native string.</param>
|
|
<returns>
|
|
The length in bytes of the native string, or 0 if <paramref name="nativeString"/> is null.
|
|
</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
The string is not null-terminated or is longer than 2147483647 bytes.
|
|
</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.LibHeifInfo">
|
|
<summary>
|
|
Provides information about LibHeif.
|
|
</summary>
|
|
<threadsafety static="true" instance="false"/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifInfo.CanWriteTwoColorProfiles">
|
|
<summary>
|
|
Gets a value indicating whether LibHeif can write two color profiles when both ICC and NCLX profiles are available.
|
|
</summary>
|
|
<value>
|
|
<see langword="true"/> if LibHeif can write two color profiles; otherwise, <see langword="false"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifInfo.Version">
|
|
<summary>
|
|
Gets the LibHeif version.
|
|
</summary>
|
|
<value>
|
|
The LibHeif version.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.LibHeifInfo.GetDecoderDescriptors(LibHeifSharp.HeifCompressionFormat)">
|
|
<summary>
|
|
Gets a list of the decoder descriptors.
|
|
</summary>
|
|
<param name="format">The compression format.</param>
|
|
<returns>The decoder descriptors.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<remarks>
|
|
This method is supported starting with LibHeif version 1.15.0, and will return an empty collection on older versions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:LibHeifSharp.LibHeifInfo.HaveDecoder(LibHeifSharp.HeifCompressionFormat)">
|
|
<summary>
|
|
Determines whether LibHeif has a decoder for the specified <see cref="T:LibHeifSharp.HeifCompressionFormat"/>.
|
|
</summary>
|
|
<param name="format">The compression format.</param>
|
|
<returns>
|
|
<see langword="true" /> if LibHeif has a decoder for the specified <see cref="T:LibHeifSharp.HeifCompressionFormat"/>;
|
|
otherwise, <see langword="false" />.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.LibHeifInfo.HaveEncoder(LibHeifSharp.HeifCompressionFormat)">
|
|
<summary>
|
|
Determines whether LibHeif has an encoder for the specified <see cref="T:LibHeifSharp.HeifCompressionFormat"/>.
|
|
</summary>
|
|
<param name="format">The compression format.</param>
|
|
<returns>
|
|
<see langword="true" /> if LibHeif an encoder for the specified <see cref="T:LibHeifSharp.HeifCompressionFormat"/>;
|
|
otherwise, <see langword="false" />.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.LibHeifInfo.HaveVersion(System.Byte,System.Byte,System.Byte)">
|
|
<summary>
|
|
Determines whether LibHeif is at least the specified version.
|
|
</summary>
|
|
<param name="major">The major version number.</param>
|
|
<param name="minor">The minor version number.</param>
|
|
<param name="maintenance">The maintenance version number.</param>
|
|
<returns>
|
|
<see langword="true" /> if LibHeif is at least the specified version;
|
|
otherwise, <see langword="false" />.
|
|
</returns>
|
|
</member>
|
|
<member name="T:LibHeifSharp.LibHeifInitializationContext">
|
|
<summary>
|
|
The LibHeif initialization context.
|
|
</summary>
|
|
<remarks>
|
|
Used by LibHeif version 1.13.0 and later to ensure that its internal state gets cleaned up.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifVersion.Is1Point10OrLater">
|
|
<summary>
|
|
Gets a value indicating whether the LibHeif version is at least 1.10.0.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the LibHeif version is at least 1.10.0; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifVersion.Is1Point11OrLater">
|
|
<summary>
|
|
Gets a value indicating whether the LibHeif version is at least 1.11.0.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the LibHeif version is at least 1.11.0; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifVersion.Is1Point12OrLater">
|
|
<summary>
|
|
Gets a value indicating whether the LibHeif version is at least 1.12.0.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the LibHeif version is at least 1.12.0; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifVersion.Is1Point13OrLater">
|
|
<summary>
|
|
Gets a value indicating whether the LibHeif version is at least 1.13.0.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the LibHeif version is at least 1.13.0; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifVersion.Is1Point15OrLater">
|
|
<summary>
|
|
Gets a value indicating whether the LibHeif version is at least 1.15.0.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the LibHeif version is at least 1.15.0; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifVersion.Is1Point16OrLater">
|
|
<summary>
|
|
Gets a value indicating whether the LibHeif version is at least 1.16.0.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the LibHeif version is at least 1.16.0; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifVersion.Is1Point16Point2OrLater">
|
|
<summary>
|
|
Gets a value indicating whether the LibHeif version is at least 1.16.2.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the LibHeif version is at least 1.16.2; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.LibHeifVersion.Is1Point17OrLater">
|
|
<summary>
|
|
Gets a value indicating whether the LibHeif version is at least 1.17.0.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the LibHeif version is at least 1.17.0; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.LibHeifVersion.ThrowIfNotSupported">
|
|
<summary>
|
|
Throws an exception if the LibHeif version is not supported.
|
|
</summary>
|
|
<exception cref="T:LibHeifSharp.HeifException">The LibHeif version is not supported.</exception>
|
|
</member>
|
|
<member name="T:LibHeifSharp.Properties.Resources">
|
|
<summary>
|
|
A strongly-typed resource class, for looking up localized strings, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ResourceManager">
|
|
<summary>
|
|
Returns the cached ResourceManager instance used by this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.Culture">
|
|
<summary>
|
|
Overrides the current thread's CurrentUICulture property for all
|
|
resource lookups using this strongly typed resource class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.AtLeastOneParameterMustBePositive">
|
|
<summary>
|
|
Looks up a localized string similar to At least one parameter must be a positive number..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.AuxiliaryImageAPINotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to This method requires LibHeif version 1.11.0 or later..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllAuxillaryImages">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the auxiliary images..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllDecoderDescriptors">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the decoder descriptors..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllDecodingWarnings">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the decoding warnings..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllMetadataBlockIds">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the meta-data block ids..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllPropertyIds">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the property ids..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllRegionItemIds">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the region item ids..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllRegionItems">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the region items..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllThumbnailIds">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the thumbnail ids..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllTopLevelImageIds">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the top-level image ids..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetAllTransformationPropertyIds">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get all of the transformation property ids..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CannotGetInlineMaskDataSize">
|
|
<summary>
|
|
Looks up a localized string similar to Could not get the inline mask data size..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CoerceStringValueToBooleanFailedFormat">
|
|
<summary>
|
|
Looks up a localized string similar to Unable to convert the {0} parameter to a Boolean..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.CoerceStringValueToIntegerFailedFormat">
|
|
<summary>
|
|
Looks up a localized string similar to Unable to convert the {0} parameter to an integer..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ColorProfileTypeNotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to The color profile type is not supported..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.DepthNonlinearRepresentationModelLargerThan2GB">
|
|
<summary>
|
|
Looks up a localized string similar to The non-linear representation model is larger than 2 GB..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.FileStreamDoesNotSupportSeeking">
|
|
<summary>
|
|
Looks up a localized string similar to The device does not support seeking..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.HeifContextAlreadyHasReader">
|
|
<summary>
|
|
Looks up a localized string similar to This HeifContext already has an associated reader..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.HeifContextCreationFailed">
|
|
<summary>
|
|
Looks up a localized string similar to Unable to create the native HeifContext..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.HeifDecodingOptionsCreationFailed">
|
|
<summary>
|
|
Looks up a localized string similar to Unable to create the native HeifDecodingOptions..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.HeifEncodingOptionsCreationFailed">
|
|
<summary>
|
|
Looks up a localized string similar to Unable to create the native HeifEncodingOptions..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.IccProfileLargerThan2Gb">
|
|
<summary>
|
|
Looks up a localized string similar to The ICC profile is larger than 2 GB..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.IccProfileZeroBytes">
|
|
<summary>
|
|
Looks up a localized string similar to The ICC profile is zero bytes..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ImageDoesNotContainChannel">
|
|
<summary>
|
|
Looks up a localized string similar to The image does not contain the specified channel..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ImageUndefinedBitDepth">
|
|
<summary>
|
|
Looks up a localized string similar to The image has an undefined bit depth..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ImageUndefinedIspeHeight">
|
|
<summary>
|
|
Looks up a localized string similar to The image has an undefined height..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ImageUndefinedIspeWidth">
|
|
<summary>
|
|
Looks up a localized string similar to The image has an undefined width..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.InlineMaskDataLargerThan2GB">
|
|
<summary>
|
|
Looks up a localized string similar to The inline mask data is larger than 2GB..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.InlineMaskImageMustBeEightBitsPerChannel">
|
|
<summary>
|
|
Looks up a localized string similar to The inline mask image Y channel must be 8-bit..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.InlineMaskImageMustHaveYChannel">
|
|
<summary>
|
|
Looks up a localized string similar to The inline mask image must have a Y channel..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.LibHeifVersionNotSupportedFormat">
|
|
<summary>
|
|
Looks up a localized string similar to LibHeif must be version {0}.{1}.{2} or later..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.MetadataBlockLargerThan2Gb">
|
|
<summary>
|
|
Looks up a localized string similar to The meta-data block is larger than 2 GB..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.NclxProfileCreationFailed">
|
|
<summary>
|
|
Looks up a localized string similar to Unable to create the native NCLX color profile..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.NoTopLevelImages">
|
|
<summary>
|
|
Looks up a localized string similar to The file does not have any top-level images..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ParameterIsEmptyFormat">
|
|
<summary>
|
|
Looks up a localized string similar to '{0}' is empty..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ParameterMustBeGreaterThanOrEqualFormat">
|
|
<summary>
|
|
Looks up a localized string similar to '{0}' must be greater than or equal to {1}..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ParameterMustBePositive">
|
|
<summary>
|
|
Looks up a localized string similar to Must be a positive number..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ParameterOutOfRangeInclusiveFormat">
|
|
<summary>
|
|
Looks up a localized string similar to '{0}' must be in the range of [{1},{2}]..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ParameterRequiredCollectionSizeFormat">
|
|
<summary>
|
|
Looks up a localized string similar to '{0}' must have {1} items..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ParameterStringIsEmptyOrWhitespaceFormat">
|
|
<summary>
|
|
Looks up a localized string similar to '{0}' is empty or contains only whitespace characters..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.PropertyAPIsNotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to This method requires LibHeif version 1.16.0 or later..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.PropertySetterRequiresLibHeif1Point15">
|
|
<summary>
|
|
Looks up a localized string similar to This property requires LibHeif version 1.15.0 or later..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.ReaderNotSet">
|
|
<summary>
|
|
Looks up a localized string similar to A reader must be set before calling before this method..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.RegionAPINotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to This method requires LibHeif version 1.16.0 or later..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.RegionMaskAPINotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to Region mask support requires LibHeif 1.17.0 or later..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.RegionMaskBitmapTooLargeFormat">
|
|
<summary>
|
|
Looks up a localized string similar to The region mask bitmap dimensions are too large, width={0}, height={1}..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.StreamCannotReadAndSeek">
|
|
<summary>
|
|
Looks up a localized string similar to The stream must support reading and seeking..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.StreamCannotWrite">
|
|
<summary>
|
|
Looks up a localized string similar to The stream must support writing..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.UnspecifiedError">
|
|
<summary>
|
|
Looks up a localized string similar to An unspecified error occurred..
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.Properties.Resources.UserDescriptionStringTooLong">
|
|
<summary>
|
|
Looks up a localized string similar to The user description string is too long..
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.PolygonPoint">
|
|
<summary>
|
|
Represents a polygon point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:LibHeifSharp.PolygonPoint.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.PolygonPoint"/> structure.
|
|
</summary>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.PolygonPoint.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.PolygonPoint.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.PolygonPoint.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.PolygonPoint.Equals(LibHeifSharp.PolygonPoint)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.PolygonPoint.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.PolygonPoint.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.PolygonPoint.op_Equality(LibHeifSharp.PolygonPoint,LibHeifSharp.PolygonPoint)">
|
|
<summary>
|
|
Implements the operator ==.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.PolygonPoint.op_Inequality(LibHeifSharp.PolygonPoint,LibHeifSharp.PolygonPoint)">
|
|
<summary>
|
|
Implements the operator !=.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RegionEllipse">
|
|
<summary>
|
|
The rectangle region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.RegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionEllipse.#ctor(LibHeifSharp.Interop.heif_region)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.RegionEllipse"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionEllipse.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionEllipse.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionEllipse.RadiusX">
|
|
<summary>
|
|
Gets the x radius.
|
|
</summary>
|
|
<value>
|
|
The x radius.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionEllipse.RadiusY">
|
|
<summary>
|
|
Gets the y radius.
|
|
</summary>
|
|
<value>
|
|
The y radius.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionEllipse.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RegionGeometry">
|
|
<summary>
|
|
The region geometry base class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionGeometry.GeometryType">
|
|
<summary>
|
|
Gets the region geometry type.
|
|
</summary>
|
|
<value>
|
|
The region geometry type.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionGeometry.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RegionGeometryType">
|
|
<summary>
|
|
The type of geometry that a region represents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RegionGeometryType.Point">
|
|
<summary>
|
|
The region geometry is a point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RegionGeometryType.Rectangle">
|
|
<summary>
|
|
The region geometry is a rectangle.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RegionGeometryType.Ellipse">
|
|
<summary>
|
|
The region geometry is an ellipse.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RegionGeometryType.Polygon">
|
|
<summary>
|
|
The region geometry is a polygon.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RegionGeometryType.ReferencedMask">
|
|
<summary>
|
|
The region geometry is a referenced mask.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RegionGeometryType.InlineMask">
|
|
<summary>
|
|
The region geometry is an in-line mask.
|
|
</summary>
|
|
</member>
|
|
<member name="F:LibHeifSharp.RegionGeometryType.Polyline">
|
|
<summary>
|
|
The region geometry is a polyline.
|
|
</summary>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RegionInlineMask">
|
|
<summary>
|
|
The inline mask region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.RegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionInlineMask.#ctor(LibHeifSharp.Interop.heif_region)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.RegionInlineMask"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionInlineMask.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionInlineMask.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionInlineMask.Width">
|
|
<summary>
|
|
Gets the width.
|
|
</summary>
|
|
<value>
|
|
The width.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionInlineMask.Height">
|
|
<summary>
|
|
Gets the height.
|
|
</summary>
|
|
<value>
|
|
The height.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionInlineMask.MaskDataFromImage(LibHeifSharp.HeifImage)">
|
|
<summary>
|
|
Creates the inline mask data from the specified image.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
<returns>The inline mask data array.</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.OutOfMemoryException">
|
|
Insufficient memory to create the inline mask data array.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionInlineMask.GetMaskData">
|
|
<summary>
|
|
Gets the mask data.
|
|
</summary>
|
|
<returns>The mask data.</returns>
|
|
<remarks>
|
|
<para>
|
|
The mask data format is one bit per pixel, most significant bit first pixel, no padding.
|
|
If the bit value is 1, the corresponding pixel is part of the region. If the bit value is 0,
|
|
the corresponding pixel is not part of the region.
|
|
</para>
|
|
</remarks>
|
|
<seealso cref="M:LibHeifSharp.RegionInlineMask.GetMaskImage"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionInlineMask.GetMaskImage">
|
|
<summary>
|
|
Gets the region mask as a <see cref="T:LibHeifSharp.HeifImage"/>.
|
|
</summary>
|
|
<returns>
|
|
The region mask image.
|
|
</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<seealso cref="M:LibHeifSharp.RegionInlineMask.GetMaskData"/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionInlineMask.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RegionPoint">
|
|
<summary>
|
|
The point region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.RegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionPoint.#ctor(LibHeifSharp.Interop.heif_region)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.RegionPoint"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionPoint.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionPoint.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionPoint.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RegionPolygon">
|
|
<summary>
|
|
The polygon region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.RegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionPolygon.#ctor(LibHeifSharp.Interop.heif_region)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.RegionPolygon"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
-or-
|
|
Overflow when getting the polygon points.
|
|
</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionPolygon.Points">
|
|
<summary>
|
|
Gets a list of the polygon points.
|
|
</summary>
|
|
<value>
|
|
The list of polygon points.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionPolygon.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RegionPolyline">
|
|
<summary>
|
|
The polyline region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.RegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionPolyline.#ctor(LibHeifSharp.Interop.heif_region)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.RegionPolyline"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
-or-
|
|
Overflow when getting the polyline points.
|
|
</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionPolyline.Points">
|
|
<summary>
|
|
Gets a list of the polyline points.
|
|
</summary>
|
|
<value>
|
|
The list of polyline points.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionPolyline.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RegionRectangle">
|
|
<summary>
|
|
The rectangle region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.RegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionRectangle.#ctor(LibHeifSharp.Interop.heif_region)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.RegionRectangle"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionRectangle.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionRectangle.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionRectangle.Width">
|
|
<summary>
|
|
Gets the width.
|
|
</summary>
|
|
<value>
|
|
The width.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionRectangle.Height">
|
|
<summary>
|
|
Gets the height.
|
|
</summary>
|
|
<value>
|
|
The height.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionRectangle.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.RegionReferencedMask">
|
|
<summary>
|
|
The referenced mask region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.RegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionReferencedMask.#ctor(LibHeifSharp.Interop.heif_region,LibHeifSharp.IHeifContext)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.RegionReferencedMask"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<param name="context">The parent file context.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="context"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionReferencedMask.ItemId">
|
|
<summary>
|
|
Gets the item id of the mask image handle.
|
|
</summary>
|
|
<value>
|
|
The item id of the mask image handle.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionReferencedMask.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionReferencedMask.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionReferencedMask.Width">
|
|
<summary>
|
|
Gets the width.
|
|
</summary>
|
|
<value>
|
|
The width.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.RegionReferencedMask.Height">
|
|
<summary>
|
|
Gets the height.
|
|
</summary>
|
|
<value>
|
|
The height.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionReferencedMask.GetMaskImage">
|
|
<summary>
|
|
Gets the region mask as a <see cref="T:LibHeifSharp.HeifImage"/>.
|
|
</summary>
|
|
<returns>
|
|
The region mask image.
|
|
</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:LibHeifSharp.HeifContext"/> has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.RegionReferencedMask.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransformedPolygonPoint">
|
|
<summary>
|
|
Represents a transformed polygon point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedPolygonPoint.#ctor(System.Double,System.Double)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.TransformedPolygonPoint"/> structure.
|
|
</summary>
|
|
<param name="x">The x.</param>
|
|
<param name="y">The y.</param>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedPolygonPoint.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedPolygonPoint.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedPolygonPoint.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedPolygonPoint.Equals(LibHeifSharp.TransformedPolygonPoint)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedPolygonPoint.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedPolygonPoint.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedPolygonPoint.op_Equality(LibHeifSharp.TransformedPolygonPoint,LibHeifSharp.TransformedPolygonPoint)">
|
|
<summary>
|
|
Implements the operator ==.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedPolygonPoint.op_Inequality(LibHeifSharp.TransformedPolygonPoint,LibHeifSharp.TransformedPolygonPoint)">
|
|
<summary>
|
|
Implements the operator !=.
|
|
</summary>
|
|
<param name="left">The left.</param>
|
|
<param name="right">The right.</param>
|
|
<returns>
|
|
The result of the operator.
|
|
</returns>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransformedRegionEllipse">
|
|
<summary>
|
|
The transformed ellipse region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.TransformedRegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionEllipse.#ctor(LibHeifSharp.Interop.heif_region,LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.TransformedRegionEllipse"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<param name="imageId">The image identifier.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionEllipse.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionEllipse.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionEllipse.RadiusX">
|
|
<summary>
|
|
Gets the x radius.
|
|
</summary>
|
|
<value>
|
|
The x radius.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionEllipse.RadiusY">
|
|
<summary>
|
|
Gets the y radius.
|
|
</summary>
|
|
<value>
|
|
The y radius.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionEllipse.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransformedRegionGeometry">
|
|
<summary>
|
|
The transformed region geometry base class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionGeometry.GeometryType">
|
|
<summary>
|
|
Gets the region geometry type.
|
|
</summary>
|
|
<value>
|
|
The region geometry type.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionGeometry.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransformedRegionPoint">
|
|
<summary>
|
|
The transformed region point geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.TransformedRegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionPoint.#ctor(LibHeifSharp.Interop.heif_region,LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.TransformedRegionPoint"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<param name="imageId">The image identifier.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionPoint.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionPoint.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionPoint.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransformedRegionPolygon">
|
|
<summary>
|
|
The transformed polygon region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.TransformedRegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionPolygon.#ctor(LibHeifSharp.Interop.heif_region,LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.TransformedRegionPolygon"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<param name="imageId">The image identifier.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
-or-
|
|
Overflow when getting the polygon points.
|
|
</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionPolygon.Points">
|
|
<summary>
|
|
Gets a list of the polygon points.
|
|
</summary>
|
|
<value>
|
|
The list of polygon points.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionPolygon.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransformedRegionPolyline">
|
|
<summary>
|
|
The transformed polyline region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.TransformedRegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionPolyline.#ctor(LibHeifSharp.Interop.heif_region,LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.TransformedRegionPolyline"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<param name="imageId">The image identifier.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
-or-
|
|
Overflow when getting the polygon points.
|
|
</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionPolyline.Points">
|
|
<summary>
|
|
Gets a list of the polyline points.
|
|
</summary>
|
|
<value>
|
|
The list of polyline points.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionPolyline.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.TransformedRegionRectangle">
|
|
<summary>
|
|
The transformed rectangle region geometry.
|
|
</summary>
|
|
<seealso cref="T:LibHeifSharp.TransformedRegionGeometry" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionRectangle.#ctor(LibHeifSharp.Interop.heif_region,LibHeifSharp.HeifItemId)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.TransformedRegionRectangle"/> class.
|
|
</summary>
|
|
<param name="region">The region.</param>
|
|
<param name="imageId">The image identifier.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionRectangle.X">
|
|
<summary>
|
|
Gets the x coordinate.
|
|
</summary>
|
|
<value>
|
|
The x coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionRectangle.Y">
|
|
<summary>
|
|
Gets the y coordinate.
|
|
</summary>
|
|
<value>
|
|
The y coordinate.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionRectangle.Width">
|
|
<summary>
|
|
Gets the width.
|
|
</summary>
|
|
<value>
|
|
The width.
|
|
</value>
|
|
</member>
|
|
<member name="P:LibHeifSharp.TransformedRegionRectangle.Height">
|
|
<summary>
|
|
Gets the height.
|
|
</summary>
|
|
<value>
|
|
The height.
|
|
</value>
|
|
</member>
|
|
<member name="M:LibHeifSharp.TransformedRegionRectangle.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.HeifRegionItem">
|
|
<summary>
|
|
Represents a LibHeif region item.
|
|
</summary>
|
|
<seealso cref="M:LibHeifSharp.HeifContext.GetRegionItem(LibHeifSharp.HeifRegionItemId)"/>
|
|
<seealso cref="M:LibHeifSharp.HeifImageHandle.AddRegion(System.Int64,System.Int64)"/>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifRegionItem.Id">
|
|
<summary>
|
|
The region item identifier.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifRegionItem.ReferenceWidth">
|
|
<summary>
|
|
The width of the encoded image prior to any transformations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:LibHeifSharp.HeifRegionItem.ReferenceHeight">
|
|
<summary>
|
|
The height of the encoded image prior to any transformations.
|
|
</summary>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddPoint(System.Int32,System.Int32)">
|
|
<summary>
|
|
Adds a point to the region geometry.
|
|
</summary>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddRectangle(System.Int32,System.Int32,System.Int64,System.Int64)">
|
|
<summary>
|
|
Adds a rectangle to the region geometry.
|
|
</summary>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="width"/> must be in the range of [0, 4294967295].
|
|
-or-
|
|
<paramref name="height"/> must be in the range of [0, 4294967295].
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddEllipse(System.Int32,System.Int32,System.Int64,System.Int64)">
|
|
<summary>
|
|
Adds an ellipse to the region geometry.
|
|
</summary>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
<param name="radiusX">The x radius.</param>
|
|
<param name="radiusY">The y radius.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="radiusX"/> must be in the range of [0, 4294967295].
|
|
-or-
|
|
<paramref name="radiusY"/> must be in the range of [0, 4294967295].
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddInlineMask(System.Byte[],System.Int32,System.Int32,System.Int64,System.Int64)">
|
|
<summary>
|
|
Adds an inline mask to the region geometry.
|
|
</summary>
|
|
<param name="maskData">The mask data.</param>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="maskData"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.ArgumentException"><paramref name="maskData"/> is empty.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="x"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="y"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="width"/> must be in the range of [0, 4294967295].
|
|
-or-
|
|
<paramref name="height"/> must be in the range of [0, 4294967295].
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddInlineMask(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.Int64,System.Int64)">
|
|
<summary>
|
|
Adds an inline mask to the region geometry.
|
|
</summary>
|
|
<param name="maskData">The mask data.</param>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<exception cref="T:System.ArgumentException"><paramref name="maskData"/> is empty.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="x"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="y"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="width"/> must be in the range of [0, 4294967295].
|
|
-or-
|
|
<paramref name="height"/> must be in the range of [0, 4294967295].
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddInlineMask(LibHeifSharp.HeifImage,System.Int32,System.Int32,System.Int64,System.Int64)">
|
|
<summary>
|
|
Adds an inline mask to the region geometry.
|
|
</summary>
|
|
<param name="image">The mask image.</param>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="image"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="x"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="y"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="width"/> must be in the range of [0, 4294967295].
|
|
-or-
|
|
<paramref name="height"/> must be in the range of [0, 4294967295].
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<exception cref="T:System.OutOfMemoryException">
|
|
Insufficient memory to create the inline mask data array.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddInlineMask(LibHeifSharp.HeifImage)">
|
|
<summary>
|
|
Adds an inline mask to the region geometry.
|
|
</summary>
|
|
<param name="image">The mask data.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="image"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
<exception cref="T:System.OutOfMemoryException">
|
|
Insufficient memory to create the inline mask data array.
|
|
</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddPolygon(System.Collections.Generic.IReadOnlyList{LibHeifSharp.PolygonPoint})">
|
|
<summary>
|
|
Adds a polygon to the region geometry.
|
|
</summary>
|
|
<param name="points">The points used in the polygon.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="points"/> is <see langword="null"/>.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddPolyline(System.Collections.Generic.IReadOnlyList{LibHeifSharp.PolygonPoint})">
|
|
<summary>
|
|
Adds a polyline to the region geometry.
|
|
</summary>
|
|
<param name="points">The points used in the polyline.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="points"/> is <see langword="null"/>.
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddReferencedMask(LibHeifSharp.HeifItemId,System.Int32,System.Int32,System.Int64,System.Int64)">
|
|
<summary>
|
|
Adds a referenced mask to the region geometry.
|
|
</summary>
|
|
<param name="itemId">The mask image item id.</param>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="x"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="y"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="width"/> must be in the range of [0, 4294967295].
|
|
-or-
|
|
<paramref name="height"/> must be in the range of [0, 4294967295].
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddReferencedMask(LibHeifSharp.HeifImageHandle,System.Int32,System.Int32,System.Int64,System.Int64)">
|
|
<summary>
|
|
Adds an referenced mask to the region geometry.
|
|
</summary>
|
|
<param name="image">The mask image.</param>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="image"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="x"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="y"/> must be greater than or equal to 0.
|
|
-or-
|
|
<paramref name="width"/> must be in the range of [0, 4294967295].
|
|
-or-
|
|
<paramref name="height"/> must be in the range of [0, 4294967295].
|
|
</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.AddReferencedMask(LibHeifSharp.HeifImageHandle)">
|
|
<summary>
|
|
Adds a referenced mask to the region geometry.
|
|
</summary>
|
|
<param name="image">The mask image.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="image"/> is <see langword="null"/>.</exception>
|
|
<exception cref="T:LibHeifSharp.HeifException">A LibHeif error occurred.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.GetRegionGeometries">
|
|
<summary>
|
|
Gets the region geometries.
|
|
</summary>
|
|
<returns>
|
|
A collection containing the region geometries.
|
|
</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
-or-
|
|
The <see cref="T:LibHeifSharp.RegionGeometryType"/> is not supported.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.GetTransformedRegionGeometries">
|
|
<summary>
|
|
Gets the transformed region geometries.
|
|
</summary>
|
|
<returns>
|
|
A collection containing the transformed region geometries.
|
|
</returns>
|
|
<exception cref="T:LibHeifSharp.HeifException">
|
|
A LibHeif error occurred.
|
|
-or-
|
|
The <see cref="T:LibHeifSharp.RegionGeometryType"/> is not supported.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.HeifRegionItem.Dispose(System.Boolean)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:LibHeifSharp.ResourceManagement.Disposable">
|
|
<summary>
|
|
A base class that implements <see cref="T:System.IDisposable" />.
|
|
</summary>
|
|
<seealso cref="T:System.IDisposable" />
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.Disposable.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.ResourceManagement.Disposable"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.Disposable.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.Disposable.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases unmanaged and - optionally - managed resources.
|
|
</summary>
|
|
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.Disposable.VerifyNotDisposed">
|
|
<summary>
|
|
Verifies that the object has not been disposed.
|
|
</summary>
|
|
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.DisposableLazy`1.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.ResourceManagement.DisposableLazy`1"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.DisposableLazy`1.#ctor(System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.ResourceManagement.DisposableLazy`1"/> class. When lazy initialization
|
|
occurs, the default constructor of the target type and the specified initialization mode are used.
|
|
</summary>
|
|
<param name="isThreadSafe">
|
|
<see langword="true"/> to make this instance usable concurrently by multiple threads; <see langword="false"/> to make
|
|
this instance usable by only one thread at a time.
|
|
</param>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.DisposableLazy`1.#ctor(System.Func{`0})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.ResourceManagement.DisposableLazy`1"/> class. When lazy initialization
|
|
occurs, the specified initialization function is used.
|
|
</summary>
|
|
<param name="valueFactory">The delegate that is invoked to produce the lazily initialized value when it is needed.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="valueFactory"/> is null.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.DisposableLazy`1.#ctor(System.Threading.LazyThreadSafetyMode)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.ResourceManagement.DisposableLazy`1"/> class that uses the default constructor
|
|
of T and the specified thread-safety mode.
|
|
</summary>
|
|
<param name="mode">One of the enumeration values that specifies the thread safety mode.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="mode"/> contains an invalid value.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.DisposableLazy`1.#ctor(System.Func{`0},System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.ResourceManagement.DisposableLazy`1"/> class. When lazy initialization
|
|
occurs, the specified initialization function and initialization mode are used.
|
|
</summary>
|
|
<param name="valueFactory">The delegate that is invoked to produce the lazily initialized value when it is needed.</param>
|
|
<param name="isThreadSafe">
|
|
<see langword="true"/> to make this instance usable concurrently by multiple threads; <see langword="false"/> to make
|
|
this instance usable by only one thread at a time.
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="valueFactory"/> is null.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.DisposableLazy`1.#ctor(System.Func{`0},System.Threading.LazyThreadSafetyMode)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:LibHeifSharp.ResourceManagement.DisposableLazy`1"/> class that uses the specified
|
|
initialization function and thread-safety mode.
|
|
</summary>
|
|
<param name="valueFactory">The delegate that is invoked to produce the lazily initialized value when it is needed.</param>
|
|
<param name="mode">One of the enumeration values that specifies the thread safety mode.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="valueFactory"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="mode"/> contains an invalid value.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.ResourceManagement.DisposableLazy`1.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsGreaterThanOrEqualTo(System.Int32,System.Int32,System.String)">
|
|
<summary>
|
|
Determines whether the specified parameter is greater than or equal to the minimum value.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="min">The inclusive minimum value.</param>
|
|
<param name="paramName">Name of the parameter.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The parameter is outside of the required range.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsInRange(System.Int32,System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Determines whether the specified parameter is within the required range.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<param name="min">The inclusive minimum value.</param>
|
|
<param name="max">The inclusive maximum value.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The parameter is outside of the required range.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsInRange(System.Int64,System.String,System.Int64,System.Int64)">
|
|
<summary>
|
|
Determines whether the specified parameter is within the required range.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<param name="min">The inclusive minimum value.</param>
|
|
<param name="max">The inclusive maximum value.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The parameter is outside of the required range.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsNotEmpty``1(System.ReadOnlyMemory{``0},System.String)">
|
|
<summary>
|
|
Determines whether the specified array is empty.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<exception cref="T:System.ArgumentException">The parameter is a empty.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsNotEmpty``1(System.ReadOnlySpan{``0},System.String)">
|
|
<summary>
|
|
Determines whether the specified array is empty.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<exception cref="T:System.ArgumentException">The parameter is empty.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsNotEmptyOrWhiteSpace(System.String,System.String)">
|
|
<summary>
|
|
Determines whether the specified parameter is empty or contains only whitespace characters, the parameter can be null.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<exception cref="T:System.ArgumentException">The parameter is empty or contains only whitespace characters.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsNotNull``1(``0,System.String)">
|
|
<summary>
|
|
Determines whether the specified parameter is null.
|
|
</summary>
|
|
<typeparam name="T">The parameter type.</typeparam>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<exception cref="T:System.ArgumentNullException">The parameter is null.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsNotNullOrEmptyArray``1(``0[],System.String)">
|
|
<summary>
|
|
Determines whether the specified array is null or empty.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<exception cref="T:System.ArgumentNullException">The parameter is null.</exception>
|
|
<exception cref="T:System.ArgumentException">The parameter is a zero-length array.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.HasSizeEqualTo``1(System.Collections.Generic.IReadOnlyList{``0},System.String,System.Int32)">
|
|
<summary>
|
|
Determines whether the specified collection is null or does not have the required length.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<param name="requiredSize">The required size of the collection.</param>
|
|
<exception cref="T:System.ArgumentNullException">The parameter is null.</exception>
|
|
<exception cref="T:System.ArgumentException">The parameter does not have the required size.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsNotNullOrWhiteSpace(System.String,System.String)">
|
|
<summary>
|
|
Determines whether the specified parameter is null, empty or contains only whitespace characters.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<exception cref="T:System.ArgumentNullException">The parameter is null.</exception>
|
|
<exception cref="T:System.ArgumentException">The parameter is empty or contains only whitespace characters.</exception>
|
|
</member>
|
|
<member name="M:LibHeifSharp.Validate.IsPositive(System.Int32,System.String)">
|
|
<summary>
|
|
Determines whether the specified parameter is greater than zero.
|
|
</summary>
|
|
<param name="param">The parameter.</param>
|
|
<param name="paramName">The name of the parameter.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The parameter is less than or equal to zero.</exception>
|
|
</member>
|
|
</members>
|
|
</doc>
|