21960 lines
1.3 MiB
21960 lines
1.3 MiB
<doc>
|
|
<assembly>
|
|
<name>SkiaSharp</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:SkiaSharp.GRBackend">
|
|
<summary>Possible 3D APIs that may be used by Ganesh.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.GRBackend.Dawn">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRBackend.Direct3D">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRBackend.Metal">
|
|
<summary>Use the Metal 3D backend. (not yet supported)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRBackend.OpenGL">
|
|
<summary>Use the OpenGL 3D backend.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRBackend.Vulkan">
|
|
<summary>Use the Vulkan 3D backend. (not yet supported)</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRBackendRenderTarget">
|
|
<summary>Wrap an existing render target created by the client in the 3D API.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The client is responsible for ensuring that the underlying 3D API object lives
|
|
at least as long as the <xref:SkiaSharp.GRBackendRenderTarget> object wrapping
|
|
it.
|
|
|
|
We require the client to explicitly provide information about the target, such
|
|
as width, height, and pixel configuration, rather than querying the 3D API for
|
|
these values. We expect these properties to be immutable even if the 3D API
|
|
doesn't require this (eg: OpenGL).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.GRBackendRenderTarget(SkiaSharp.GRBackend,SkiaSharp.GRBackendRenderTargetDesc)">
|
|
<param name="backend">The backend to use.</param>
|
|
<param name="desc">The description of the backend render target.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.GRBackendRenderTarget" /> with the properties from the specified description.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.GRBackendRenderTarget(System.Int32,System.Int32,System.Int32,SkiaSharp.GRVkImageInfo)">
|
|
<param name="width">To be added.</param>
|
|
<param name="height">To be added.</param>
|
|
<param name="sampleCount">To be added.</param>
|
|
<param name="vkImageInfo">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.GRBackendRenderTarget(System.Int32,System.Int32,System.Int32,System.Int32,SkiaSharp.GRGlFramebufferInfo)">
|
|
<param name="width">The width of the render target.</param>
|
|
<param name="height">The height of the render target.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="stencilBits">The number of bits of stencil per pixel.</param>
|
|
<param name="glInfo">The OpenGL framebuffer information.</param>
|
|
<summary>Creates a new OpenGL <see cref="T:SkiaSharp.GRBackendRenderTarget" /> with the specified properties and framebuffer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTarget.Backend">
|
|
<summary>Gets the backend for this render target.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendRenderTarget.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.GRBackendRenderTarget" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.GRBackendRenderTarget" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendRenderTarget.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendRenderTarget.GetGlFramebufferInfo">
|
|
<summary>Returns the framebuffer info that this object wraps.</summary>
|
|
<returns>Returns the framebuffer info, if this object wraps an OpenGL framebuffer, otherwise an empty info instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendRenderTarget.GetGlFramebufferInfo(SkiaSharp.GRGlFramebufferInfo@)">
|
|
<param name="glInfo">The framebuffer info, if this object wraps an OpenGL framebuffer.</param>
|
|
<summary>Returns the framebuffer info that this object wraps.</summary>
|
|
<returns>Returns true if this object wraps an OpenGL framebuffer, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTarget.Height">
|
|
<summary>Gets the height in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTarget.IsValid">
|
|
<summary>Gets a value indicating whether or not the <see cref="T:SkiaSharp.GRBackendRenderTarget" /> was initialized.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTarget.Rect">
|
|
<summary>Gets a rectangle with the current width and height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTarget.SampleCount">
|
|
<summary>Gets the number of samples per pixel.</summary>
|
|
<value />
|
|
<remarks>This is used to influence decisions about applying other forms of anti-aliasing.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTarget.Size">
|
|
<summary>Gets the current size of the 3D API object.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTarget.StencilBits">
|
|
<summary>Gets the number of bits of stencil per-pixel.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTarget.Width">
|
|
<summary>Gets the width in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.GRBackendRenderTargetDesc">
|
|
<summary>Wrap an existing render target created by the client in the 3D API with an underlying GRRenderTarget object.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The client is responsible for ensuring that the underlying 3D API object lives
|
|
at least as long as the GRRenderTarget object wrapping it.
|
|
|
|
We require the client to explicitly provide information about the target, such
|
|
as width, height, and pixel configuration, rather than querying the 3D API for
|
|
these values. We expect these properties to be immutable even if the 3D API
|
|
doesn't require this (eg: OpenGL).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTargetDesc.Config">
|
|
<summary>Gets or sets the color format.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendRenderTargetDesc.Equals(SkiaSharp.GRBackendRenderTargetDesc)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendRenderTargetDesc.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendRenderTargetDesc.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTargetDesc.Height">
|
|
<summary>Gets or sets the height in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendRenderTargetDesc.op_Equality(SkiaSharp.GRBackendRenderTargetDesc,SkiaSharp.GRBackendRenderTargetDesc)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendRenderTargetDesc.op_Inequality(SkiaSharp.GRBackendRenderTargetDesc,SkiaSharp.GRBackendRenderTargetDesc)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTargetDesc.Origin">
|
|
<summary>Gets or sets the pixel origin.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTargetDesc.Rect">
|
|
<summary>Gets a rectangle with the current width and height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTargetDesc.RenderTargetHandle">
|
|
<summary>Gets or sets the handle to the 3D API object.</summary>
|
|
<value />
|
|
<remarks>When using OpenGL, it is the FBO ID.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTargetDesc.SampleCount">
|
|
<summary>Gets or sets the number of samples per pixel.</summary>
|
|
<value />
|
|
<remarks>This is used to influence decisions about applying other forms of anti-aliasing.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTargetDesc.Size">
|
|
<summary>Gets the current size of the 3D API object.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTargetDesc.StencilBits">
|
|
<summary>Gets or sets the number of bits of stencil per pixel.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendRenderTargetDesc.Width">
|
|
<summary>Gets or sets the width in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.GRBackendState">
|
|
<summary>Various flags for the <see cref="M:SkiaSharp.GRContext.ResetContext(SkiaSharp.GRBackendState)" /> method.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.GRBackendState.All">
|
|
<summary>Reset all the context state for any backend.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRBackendState.None">
|
|
<summary>Reset nothing.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRBackendTexture">
|
|
<summary>Wrap an existing texture created by the client in the 3D API.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The client is responsible for ensuring that the underlying 3D API object lives
|
|
at least as long as the <xref:SkiaSharp.GRBackendRenderTarget> object wrapping
|
|
it.
|
|
|
|
We require the client to explicitly provide information about the target, such
|
|
as width, height, and pixel configuration, rather than querying the 3D API for
|
|
these values. We expect these properties to be immutable even if the 3D API
|
|
doesn't require this (eg: OpenGL).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.GRBackendTexture(SkiaSharp.GRBackendTextureDesc)">
|
|
<param name="desc">The description of the backend texture.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.GRBackendTexture" /> with the properties from the specified description.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.GRBackendTexture(SkiaSharp.GRGlBackendTextureDesc)">
|
|
<param name="desc">The description of the backend texture.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.GRBackendTexture" /> with the properties from the specified description.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.GRBackendTexture(System.Int32,System.Int32,SkiaSharp.GRVkImageInfo)">
|
|
<param name="width">To be added.</param>
|
|
<param name="height">To be added.</param>
|
|
<param name="vkInfo">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.GRBackendTexture(System.Int32,System.Int32,System.Boolean,SkiaSharp.GRGlTextureInfo)">
|
|
<param name="width">The width of the render target.</param>
|
|
<param name="height">The height of the render target.</param>
|
|
<param name="mipmapped">Whether or not the texture is mipmapped.</param>
|
|
<param name="glInfo">The OpenGL texture information.</param>
|
|
<summary>Creates a new OpenGL <see cref="T:SkiaSharp.GRBackendTexture" /> with the specified properties and texture.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTexture.Backend">
|
|
<summary>Gets the backend for this texture.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendTexture.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.GRBackendTexture" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.GRBackendTexture" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendTexture.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendTexture.GetGlTextureInfo">
|
|
<summary>Returns the texture info that this object wraps.</summary>
|
|
<returns>Returns the texture info, if this object wraps an OpenGL texture, otherwise an empty info instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendTexture.GetGlTextureInfo(SkiaSharp.GRGlTextureInfo@)">
|
|
<param name="glInfo">The texture info, if this object wraps an OpenGL texture.</param>
|
|
<summary>Returns the texture info that this object wraps.</summary>
|
|
<returns>Returns true if this object wraps an OpenGL texture, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTexture.HasMipMaps">
|
|
<summary>Gets a value indicating whether this texture is mipmapped.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTexture.Height">
|
|
<summary>Gets the height in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTexture.IsValid">
|
|
<summary>Gets a value indicating whether or not the <see cref="T:SkiaSharp.GRBackendTexture" /> was initialized.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTexture.Rect">
|
|
<summary>Gets a rectangle with the current width and height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTexture.Size">
|
|
<summary>Gets the current size of the 3D API object.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTexture.Width">
|
|
<summary>Gets the width in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.GRBackendTextureDesc">
|
|
<summary>Wrap an existing texture created by the client in the 3D API with an underlying GRTexture object.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The client is responsible for ensuring that the texture lives at least as long
|
|
as the GRTexture object wrapping it.
|
|
|
|
We require the client to explicitly provide information about the texture, such
|
|
as width, height, and pixel configuration, rather than querying the 3D API for
|
|
these values. We expect these to be immutable even if the 3D API doesn't
|
|
require this (OpenGL).
|
|
|
|
Textures that are also render targets are supported as well. Any ancillary 3D
|
|
API (stencil buffer, FBO id, etc) objects necessary will be managed.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTextureDesc.Config">
|
|
<summary>Gets or sets the color format.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendTextureDesc.Equals(SkiaSharp.GRBackendTextureDesc)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendTextureDesc.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTextureDesc.Flags">
|
|
<summary>Gets or sets additional options about the texture.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendTextureDesc.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTextureDesc.Height">
|
|
<summary>Gets or sets the height in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendTextureDesc.op_Equality(SkiaSharp.GRBackendTextureDesc,SkiaSharp.GRBackendTextureDesc)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRBackendTextureDesc.op_Inequality(SkiaSharp.GRBackendTextureDesc,SkiaSharp.GRBackendTextureDesc)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTextureDesc.Origin">
|
|
<summary>Gets or sets the pixel origin.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTextureDesc.Rect">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTextureDesc.SampleCount">
|
|
<summary>Gets or sets the number of samples per pixel.</summary>
|
|
<value />
|
|
<remarks>If the render target flag is set and sample count is greater than 0, then an MSAA buffer that resolves to the texture will be created.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTextureDesc.Size">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTextureDesc.TextureHandle">
|
|
<summary>Gets or sets the handle to the 3D API object.</summary>
|
|
<value />
|
|
<remarks>When using OpenGL, it is the Texture ID.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRBackendTextureDesc.Width">
|
|
<summary>Gets or sets the width in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.GRBackendTextureDescFlags">
|
|
<summary>Additional options for a backend texture.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.GRBackendTextureDescFlags.None">
|
|
<summary>No flags enabled.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRBackendTextureDescFlags.RenderTarget">
|
|
<summary>Indicates that the texture is also a render target.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRContext">
|
|
<summary>Represents an underlying backend 3D API context.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.AbandonContext(System.Boolean)">
|
|
<param name="releaseResources">Use true to indicate that the underlying 3D context is not yet lost and the <see cref="T:SkiaSharp.GRContext" /> will cleanup all allocated resources before returning. Using false will ensure that the destructors of the <see cref="T:SkiaSharp.GRContext" /> and any of its created resource objects will not make backend 3D API calls.</param>
|
|
<summary>Abandons all GPU resources and assumes the underlying backend 3D API context is not longer usable. After returning it will assume that the underlying context may no longer be valid.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContext.Backend">
|
|
<summary>Gets the backend that this context is wrapping.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.Create(SkiaSharp.GRBackend)">
|
|
<param name="backend">The backend to use.</param>
|
|
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context using the default interface for the specified backend.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.Create(SkiaSharp.GRBackend,SkiaSharp.GRGlInterface)">
|
|
<param name="backend">The backend to use.</param>
|
|
<param name="backendContext">The backend interface to use.</param>
|
|
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.Create(SkiaSharp.GRBackend,System.IntPtr)">
|
|
<param name="backend">The backend to use.</param>
|
|
<param name="backendContext">The backend interface to use.</param>
|
|
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.Create(SkiaSharp.GRBackend,SkiaSharp.GRGlInterface,SkiaSharp.GRContextOptions)">
|
|
<param name="backend">The backend to use.</param>
|
|
<param name="backendContext">The backend interface to use.</param>
|
|
<param name="options">The context-creation options.</param>
|
|
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.Create(SkiaSharp.GRBackend,System.IntPtr,SkiaSharp.GRContextOptions)">
|
|
<param name="backend">The backend to use.</param>
|
|
<param name="backendContext">The backend interface to use.</param>
|
|
<param name="options">The context-creation options.</param>
|
|
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.CreateGl">
|
|
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for an OpenGL context.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.CreateGl(SkiaSharp.GRContextOptions)">
|
|
<param name="options">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.CreateGl(SkiaSharp.GRGlInterface)">
|
|
<param name="backendContext">The OpenGL interface to use.</param>
|
|
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for an OpenGL context.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.CreateGl(SkiaSharp.GRGlInterface,SkiaSharp.GRContextOptions)">
|
|
<param name="backendContext">To be added.</param>
|
|
<param name="options">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.CreateVulkan(SkiaSharp.GRVkBackendContext)">
|
|
<param name="backendContext">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.CreateVulkan(SkiaSharp.GRVkBackendContext,SkiaSharp.GRContextOptions)">
|
|
<param name="backendContext">To be added.</param>
|
|
<param name="options">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.GRContext" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.GRContext" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.DisposeNative">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.DumpMemoryStatistics(SkiaSharp.SKTraceMemoryDump)">
|
|
<param name="dump">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.Flush">
|
|
<summary>Call to ensure all drawing to the context has been issued to the underlying 3D API.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.Flush(System.Boolean,System.Boolean)">
|
|
<param name="submit">To be added.</param>
|
|
<param name="synchronous">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.GetMaxSurfaceSampleCount(SkiaSharp.SKColorType)">
|
|
<param name="colorType">The color type.</param>
|
|
<summary>Get the maximum supported sample count for the specified color type.</summary>
|
|
<returns>Returns the maximum supported sample count.</returns>
|
|
<remarks>1 is returned if only non-MSAA rendering is supported for the color type. 0 is returned if rendering to this color type is not supported at all.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.GetRecommendedSampleCount(SkiaSharp.GRPixelConfig,System.Single)">
|
|
<param name="config">The configuration of the render target.</param>
|
|
<param name="dpi">The display density in dots per inch.</param>
|
|
<summary>Returns the recommended sample count for a render target when using this context.</summary>
|
|
<returns>Returns the recommended sample count.</returns>
|
|
<remarks>May return 0 if MSAA is not supported or recommended to be used by default.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.GetResourceCacheLimit">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.GetResourceCacheLimits(System.Int32@,System.Int64@)">
|
|
<param name="maxResources">The maximum number of resources that can be held in the cache.</param>
|
|
<param name="maxResourceBytes">The maximum number of bytes of video memory that can be held in the cache.</param>
|
|
<summary>Returns the current GPU resource cache limits.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.GetResourceCacheUsage(System.Int32@,System.Int64@)">
|
|
<param name="maxResources">The number of resources that are held in the cache.</param>
|
|
<param name="maxResourceBytes">The total number of bytes of video memory held in the cache.</param>
|
|
<summary>Returns the current GPU resource cache usage.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContext.IsAbandoned">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.PurgeResources">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.PurgeUnlockedResources(System.Boolean)">
|
|
<param name="scratchResourcesOnly">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.PurgeUnlockedResources(System.Int64,System.Boolean)">
|
|
<param name="bytesToPurge">To be added.</param>
|
|
<param name="preferScratchResources">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.PurgeUnusedResources(System.Int64)">
|
|
<param name="milliseconds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.ResetContext(SkiaSharp.GRBackendState)">
|
|
<param name="state">Flags to control what is reset.</param>
|
|
<summary>Informs the context that the state was modified and should resend.</summary>
|
|
<remarks>The context normally assumes that no outsider is setting state within the underlying 3D API's context/device/whatever. This method shouldn't be called frequently for good performance.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.ResetContext(SkiaSharp.GRGlBackendState)">
|
|
<param name="state">Flags to control what is reset.</param>
|
|
<summary>Informs the context that the state was modified and should resend.</summary>
|
|
<remarks>The context normally assumes that no outsider is setting state within the underlying 3D API's context/device/whatever. This method shouldn't be called frequently for good performance.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.ResetContext(System.UInt32)">
|
|
<param name="state">Flags to control what is reset.</param>
|
|
<summary>Informs the context that the state was modified and should resend.</summary>
|
|
<remarks>The context normally assumes that no outsider is setting state within the underlying 3D API's context/device/whatever. This method shouldn't be called frequently for good performance.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.SetResourceCacheLimit(System.Int64)">
|
|
<param name="maxResourceBytes">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.SetResourceCacheLimits(System.Int32,System.Int64)">
|
|
<param name="maxResources">The maximum number of resources that can be held in the cache.</param>
|
|
<param name="maxResourceBytes">The maximum number of bytes of video memory that can be held in the cache.</param>
|
|
<summary>Specify the GPU resource cache limits.</summary>
|
|
<remarks>If the current cache exceeds either of these, it will be purged (LRU) to keep the cache within these limits.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRContext.Submit(System.Boolean)">
|
|
<param name="synchronous">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRContextOptions">
|
|
<summary>Represents the collection of options for the construction of a context.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.GRContextOptions">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.AllowPathMaskCaching">
|
|
<summary>Gets or sets a value indicating whether to allow path mask textures to be cached.</summary>
|
|
<value />
|
|
<remarks>This is only really useful if paths are commonly rendered at the same scale and fractional translation. Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.AvoidStencilBuffers">
|
|
<summary>Gets or sets a value indicating whether to avoid allocating stencil buffers.</summary>
|
|
<value />
|
|
<remarks>Bugs on certain drivers cause stencil buffers to leak. This flag causes Skia to avoid allocating stencil buffers and use alternate rasterization paths, avoiding the leak.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.BufferMapThreshold">
|
|
<summary>Gets or sets the threshold, in bytes, above which a buffer mapping API will be used to map vertex and index buffers to CPU memory in order to update them.</summary>
|
|
<value />
|
|
<remarks>A value of -1 means the context should deduce the optimal value for this platform. Default is -1.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.Default">
|
|
<summary>Gets a new instance with the values set to the defaults.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.DisableGpuYuvConversion">
|
|
<summary>Gets or sets a value indicating whether the GPU will be used to perform YUV -> RGB conversion when generating textures from codec-backed images.</summary>
|
|
<value />
|
|
<remarks>Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.DoManualMipmapping">
|
|
<summary>Gets or sets a value indicating whether to construct mipmaps manually, via repeated downsampling draw-calls.</summary>
|
|
<value />
|
|
<remarks>This is used when the driver's implementation (glGenerateMipmap) contains bugs. This requires mipmap level and LOD control (for example, desktop or ES3). Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.EnableInstancedRendering">
|
|
<summary>Gets or sets a value indicating whether to enable instanced rendering as long as all required functionality is supported by the hardware.</summary>
|
|
<value />
|
|
<remarks>Instanced rendering is still experimental at this point and disabled by default. Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.GlyphCacheTextureMaximumBytes">
|
|
<summary>Gets or sets the maximum size of cache textures used for the SkiaSharp Glyph cache.</summary>
|
|
<value />
|
|
<remarks>Default is 2048 * 1024 * 4.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.GpuPathRenderers">
|
|
<summary>Gets or sets the GPU path renderers.</summary>
|
|
<value />
|
|
<remarks>Default is <see cref="F:SkiaSharp.GRContextOptionsGpuPathRenderers.All" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.ImmediateMode">
|
|
<summary>Gets or sets a value indicating whether the context operates in immediate mode.</summary>
|
|
<value />
|
|
<remarks>The context will issue all draws to the backend API immediately. Intended to ease debugging. Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.MaxTextureSizeOverride">
|
|
<summary>Gets or sets the maximum size of a texture.</summary>
|
|
<value />
|
|
<remarks>An option to override feature detection using backend API queries. The override can only reduce the feature set or limits, never increase them beyond the detected values. Default is 0x7FFFFFFF.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.MaxTileSizeOverride">
|
|
<summary>Gets or sets the maximum size (if non-zero) of a tile for software-backed images and bitmaps rendered by the device.</summary>
|
|
<value />
|
|
<remarks>An option to override feature detection using backend API queries. The override can only reduce the feature set or limits, never increase them beyond the detected values. Default is 0.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.RequireDecodeDisableForSrgb">
|
|
<summary>Gets or sets a value indicating whether sRGB support will be disabled if sRGB decoding cannot be enabled.</summary>
|
|
<value />
|
|
<remarks>Default is true.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.RuntimeProgramCacheSize">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.SuppressDualSourceBlending">
|
|
<summary>Gets or sets a value indicating whether to suppress dual source blending.</summary>
|
|
<value />
|
|
<remarks>Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.SuppressPathRendering">
|
|
<summary>Gets or sets a value indicating whether the caps will never report driver support for path rendering.</summary>
|
|
<value />
|
|
<remarks>Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.SuppressPrints">
|
|
<summary>Gets or sets a value indicating whether to suppress prints for the <see cref="T:SkiaSharp.GRContext" />.</summary>
|
|
<value />
|
|
<remarks>Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.UseDrawInsteadOfPartialRenderTargetWrite">
|
|
<summary>Gets or sets a value indicating whether to avoid partial writes.</summary>
|
|
<value />
|
|
<remarks>Some GPUs have problems with partial writes of the render target. Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.UseShaderSwizzling">
|
|
<summary>Gets or sets a value indicating whether to do all swizzling manually in the shader and don't rely on extensions to do swizzling.</summary>
|
|
<value />
|
|
<remarks>Default is false.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRContextOptions.WireframeMode">
|
|
<summary>Gets or sets a value indicating whether to render everything in wireframe.</summary>
|
|
<value />
|
|
<remarks>Default is false.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRContextOptionsGpuPathRenderers">
|
|
<summary>Various GPU path renderers for use with <see cref="T:SkiaSharp.GRContextOptions" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.AaConvex">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.AaHairline">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.AaLinearizing">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.All">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.DashLine">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.Default">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.Msaa">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.None">
|
|
<summary>Always use software masks.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.Small">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.StencilAndCover">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRContextOptionsGpuPathRenderers.Tessellating">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRGlBackendState">
|
|
<summary>Various flags for the <see cref="M:SkiaSharp.GRContext.ResetContext(SkiaSharp.GRGlBackendState)" /> method when using a <see cref="F:SkiaSharp.GRBackend.OpenGL" /> backend.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.All">
|
|
<summary>Reset all the context state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.Blend">
|
|
<summary>Reset the blend state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.FixedFunction">
|
|
<summary>Reset the fixed function state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.Misc">
|
|
<summary>Reset miscellaneous state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.MSAAEnable">
|
|
<summary>Reset the MSAA state</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.None">
|
|
<summary>Reset nothing.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.PathRendering">
|
|
<summary>Reset the path rendering state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.PixelStore">
|
|
<summary>Reset the pixel store state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.Program">
|
|
<summary>Reset the program state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.RenderTarget">
|
|
<summary>Reset the render target.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.Stencil">
|
|
<summary>Reset the stencil state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.TextureBinding">
|
|
<summary>Reset the texture binding state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.Vertex">
|
|
<summary>Reset the vertex buffer state.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRGlBackendState.View">
|
|
<summary>Reset the scissor and viewport state.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRGlBackendTextureDesc">
|
|
<summary>Wrap an existing OpenGL texture created by the client in the 3D API with an underlying GRTexture object.</summary>
|
|
<remarks>
|
|
<para>The client is responsible for ensuring that the texture lives at least as long as the GRTexture object wrapping it. </para>
|
|
<para>We require the client to explicitly provide information about the texture, such as width, height, and pixel configuration, rather than querying the 3D API for these values. We expect these to be immutable even if the 3D API doesn't require this (OpenGL).</para>
|
|
<para>Textures that are also render targets are supported as well. Any ancillary 3D API (stencil buffer, FBO id, etc) objects necessary will be managed.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlBackendTextureDesc.Config">
|
|
<summary>Gets or sets the color format.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlBackendTextureDesc.Equals(SkiaSharp.GRGlBackendTextureDesc)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlBackendTextureDesc.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlBackendTextureDesc.Flags">
|
|
<summary>Gets or sets additional options about the texture.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlBackendTextureDesc.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlBackendTextureDesc.Height">
|
|
<summary>Gets or sets the height in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlBackendTextureDesc.op_Equality(SkiaSharp.GRGlBackendTextureDesc,SkiaSharp.GRGlBackendTextureDesc)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlBackendTextureDesc.op_Inequality(SkiaSharp.GRGlBackendTextureDesc,SkiaSharp.GRGlBackendTextureDesc)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlBackendTextureDesc.Origin">
|
|
<summary>Gets or sets the pixel origin.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlBackendTextureDesc.Rect">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlBackendTextureDesc.SampleCount">
|
|
<summary>Gets or sets the number of samples per pixel.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlBackendTextureDesc.Size">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlBackendTextureDesc.TextureHandle">
|
|
<summary>Gets or sets the handle to the OpenGL texture.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlBackendTextureDesc.Width">
|
|
<summary>Gets or sets the width in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.GRGlFramebufferInfo">
|
|
<summary>Represents a handle to an existing OpenGL framebuffer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.GRGlFramebufferInfo(System.UInt32)">
|
|
<param name="fboId">The OpenGL framebuffer ID.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.GRGlFramebufferInfo" /> with the specified parameters.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.GRGlFramebufferInfo(System.UInt32,System.UInt32)">
|
|
<param name="fboId">The OpenGL framebuffer ID.</param>
|
|
<param name="format">The sized, internal format of the OpenGL framebuffer.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.GRGlFramebufferInfo" /> with the specified parameters.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlFramebufferInfo.Equals(SkiaSharp.GRGlFramebufferInfo)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlFramebufferInfo.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlFramebufferInfo.Format">
|
|
<summary>Gets or sets the sized, internal format of the OpenGL framebuffer.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlFramebufferInfo.FramebufferObjectId">
|
|
<summary>Gets or sets the OpenGL framebuffer ID.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlFramebufferInfo.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlFramebufferInfo.op_Equality(SkiaSharp.GRGlFramebufferInfo,SkiaSharp.GRGlFramebufferInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlFramebufferInfo.op_Inequality(SkiaSharp.GRGlFramebufferInfo,SkiaSharp.GRGlFramebufferInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRGlGetProcDelegate">
|
|
<param name="context">The user data passed to the assembling methods of <see cref="T:SkiaSharp.GRGlInterface" />.</param>
|
|
<param name="name">The name of the endpoint to locate.</param>
|
|
<summary>The delegate that is used when locating the various endpoints of an OpenGL implementation.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.GRGlGetProcedureAddressDelegate">
|
|
<param name="name">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRGlInterface">
|
|
<summary>The <see cref="T:SkiaSharp.GRGlInterface" /> is used to interface with OpenGL.</summary>
|
|
<remarks>A <see cref="T:SkiaSharp.GRContext" /> does not interact directly with the underlying backend, instead it uses an OpenGL interface.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.AssembleAngleInterface(SkiaSharp.GRGlGetProcDelegate)">
|
|
<param name="get">The delegate used to locate entry points.</param>
|
|
<summary>Assemble an ANGLE <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.AssembleAngleInterface(System.Object,SkiaSharp.GRGlGetProcDelegate)">
|
|
<param name="context">The user data to use in the delegate.</param>
|
|
<param name="get">The delegate used to locate entry points.</param>
|
|
<summary>Assemble an ANGLE <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.AssembleGlesInterface(SkiaSharp.GRGlGetProcDelegate)">
|
|
<param name="get">The delegate used to locate entry points.</param>
|
|
<summary>Assemble an OpenGL ES <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.AssembleGlesInterface(System.Object,SkiaSharp.GRGlGetProcDelegate)">
|
|
<param name="context">The user data to use in the delegate.</param>
|
|
<param name="get">The delegate used to locate entry points.</param>
|
|
<summary>Assemble an OpenGL ES <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.AssembleGlInterface(SkiaSharp.GRGlGetProcDelegate)">
|
|
<param name="get">The delegate used to locate entry points.</param>
|
|
<summary>Assemble an OpenGL <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.AssembleGlInterface(System.Object,SkiaSharp.GRGlGetProcDelegate)">
|
|
<param name="context">The user data to use in the delegate.</param>
|
|
<param name="get">The delegate used to locate entry points.</param>
|
|
<summary>Assemble an OpenGL <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.AssembleInterface(SkiaSharp.GRGlGetProcDelegate)">
|
|
<param name="get">The delegate used to locate entry points.</param>
|
|
<summary>Assemble an platform-specific <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.AssembleInterface(System.Object,SkiaSharp.GRGlGetProcDelegate)">
|
|
<param name="context">The user data to use in the delegate.</param>
|
|
<param name="get">The delegate used to locate entry points.</param>
|
|
<summary>Assemble an platform-specific <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.Clone">
|
|
<summary>Returns a copy of the current interface.</summary>
|
|
<returns>Returns a copy.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.Create">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.Create(SkiaSharp.GRGlGetProcedureAddressDelegate)">
|
|
<param name="get">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateAngle">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateAngle(SkiaSharp.GRGlGetProcedureAddressDelegate)">
|
|
<param name="get">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateDefaultInterface">
|
|
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the platform-default OpenGL implementation.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks>On Windows, this is typically ANGLE, on mobile it is typically OpenGL ES and on desktop it is typically OpenGL.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateEvas(System.IntPtr)">
|
|
<param name="evas">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateGles(SkiaSharp.GRGlGetProcedureAddressDelegate)">
|
|
<param name="get">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateNativeAngleInterface">
|
|
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the ANGLE OpenGL implementation.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateNativeEvasInterface(System.IntPtr)">
|
|
<param name="evas">The pointer to the Evas_GL object to use.</param>
|
|
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the Evas OpenGL implementation.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateNativeGlInterface">
|
|
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the platform OpenGL implementation.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateOpenGl(SkiaSharp.GRGlGetProcedureAddressDelegate)">
|
|
<param name="get">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.CreateWebGl(SkiaSharp.GRGlGetProcedureAddressDelegate)">
|
|
<param name="get">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.GRGlInterface" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.GRGlInterface" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.HasExtension(System.String)">
|
|
<param name="extension">The extension to check for.</param>
|
|
<summary>Checks to see if the underlying OpenGL backend has the specified extension.</summary>
|
|
<returns>Returns true if the backend has the extension, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlInterface.Validate">
|
|
<summary>Validates that the <see cref="T:SkiaSharp.GRGlInterface" /> supports its advertised standard.</summary>
|
|
<returns>Returns true if all the entry points are specified, and any required extensions exist.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.GRGlTextureInfo">
|
|
<summary>Represents a handle to an existing OpenGL texture.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.GRGlTextureInfo(System.UInt32,System.UInt32)">
|
|
<param name="target">To be added.</param>
|
|
<param name="id">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.GRGlTextureInfo(System.UInt32,System.UInt32,System.UInt32)">
|
|
<param name="target">The OpenGL texture target.</param>
|
|
<param name="id">The OpenGL texture ID.</param>
|
|
<param name="format">The sized, internal format of the OpenGL texture.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.GRGlTextureInfo" /> with the specified parameters.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlTextureInfo.Equals(SkiaSharp.GRGlTextureInfo)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlTextureInfo.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlTextureInfo.Format">
|
|
<summary>Gets or sets the sized, internal format of the OpenGL texture.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlTextureInfo.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlTextureInfo.Id">
|
|
<summary>Gets or sets the OpenGL texture ID.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlTextureInfo.op_Equality(SkiaSharp.GRGlTextureInfo,SkiaSharp.GRGlTextureInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRGlTextureInfo.op_Inequality(SkiaSharp.GRGlTextureInfo,SkiaSharp.GRGlTextureInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRGlTextureInfo.Target">
|
|
<summary>Gets or sets the OpenGL texture target.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.GRPixelConfig">
|
|
<summary>Various pixel configurations supported.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Alpha16">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Alpha8">
|
|
<summary>8-bit Alpha.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Alpha8AsAlpha">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Alpha8AsRed">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.AlphaHalf">
|
|
<summary>Single 16-bit float channel.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.AlphaHalfAsLum">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.AlphaHalfAsRed">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Bgra8888">
|
|
<summary>Premultiplied 32-bit channel. Byte order is BGRA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Gray8">
|
|
<summary>8-bit grayscale color channel.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Gray8AsLum">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Gray8AsRed">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rg1616">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rg88">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rgb565">
|
|
<summary>16-bit channel. Byte order is RGB.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rgb888">
|
|
<summary>Premultiplied, opaque 32-bit color with the format RGB, with 8 bits per color component.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rgb888x">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rgba1010102">
|
|
<summary>Premultiplied 32-bit color with the format RGBA, with 10 bits per color component and 2 bits for the alpha component.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rgba16161616">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rgba4444">
|
|
<summary>Premultiplied 16-bit channel. Byte order is RGBA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rgba8888">
|
|
<summary>Premultiplied 32-bit channel. Byte order is RGBA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Rgba8888SInt">
|
|
<summary>Premultiplied 32-bit (signed) channel. Byte order is BGRA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.RgbaFloat">
|
|
<summary>32-bit channel. Byte order is RGBA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.RgbaHalf">
|
|
<summary>16-bit channel. Byte order is RGBA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.RgbaHalfClamped">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.RgbEtc1">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.RgFloat">
|
|
<summary>32-bit channel. Byte order is RG.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.RgHalf">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Sbgra8888">
|
|
<summary>Premultiplied and sRGB. Byte order is BGRA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Srgba8888">
|
|
<summary>Premultiplied and sRGB. Byte order is RGBA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRPixelConfig.Unknown">
|
|
<summary>The pixel configuration is not known or not set.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRRecordingContext">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRRecordingContext.Backend">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRRecordingContext.GetMaxSurfaceSampleCount(SkiaSharp.SKColorType)">
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRSurfaceOrigin">
|
|
<summary>The origin of a texture.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.GRSurfaceOrigin.BottomLeft">
|
|
<summary>Origin is at the bottom-left.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.GRSurfaceOrigin.TopLeft">
|
|
<summary>Origin is at the top-left.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRVkAlloc">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkAlloc.BackendMemory">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkAlloc.Equals(SkiaSharp.GRVkAlloc)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkAlloc.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkAlloc.Flags">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkAlloc.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkAlloc.Memory">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkAlloc.Offset">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkAlloc.op_Equality(SkiaSharp.GRVkAlloc,SkiaSharp.GRVkAlloc)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkAlloc.op_Inequality(SkiaSharp.GRVkAlloc,SkiaSharp.GRVkAlloc)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkAlloc.Size">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRVkBackendContext">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.GRVkBackendContext">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkBackendContext.Dispose">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkBackendContext.Dispose(System.Boolean)">
|
|
<param name="disposing">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.Extensions">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.GetProcedureAddress">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.GraphicsQueueIndex">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.MaxAPIVersion">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.ProtectedContext">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.VkDevice">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.VkInstance">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.VkPhysicalDevice">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.VkPhysicalDeviceFeatures">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.VkPhysicalDeviceFeatures2">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkBackendContext.VkQueue">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRVkExtensions">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkExtensions.Create(SkiaSharp.GRVkGetProcedureAddressDelegate,System.IntPtr,System.IntPtr,System.String[],System.String[])">
|
|
<param name="getProc">To be added.</param>
|
|
<param name="vkInstance">To be added.</param>
|
|
<param name="vkPhysicalDevice">To be added.</param>
|
|
<param name="instanceExtensions">To be added.</param>
|
|
<param name="deviceExtensions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkExtensions.DisposeNative">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkExtensions.HasExtension(System.String,System.Int32)">
|
|
<param name="extension">To be added.</param>
|
|
<param name="minVersion">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkExtensions.Initialize(SkiaSharp.GRVkGetProcedureAddressDelegate,System.IntPtr,System.IntPtr)">
|
|
<param name="getProc">To be added.</param>
|
|
<param name="vkInstance">To be added.</param>
|
|
<param name="vkPhysicalDevice">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkExtensions.Initialize(SkiaSharp.GRVkGetProcedureAddressDelegate,System.IntPtr,System.IntPtr,System.String[],System.String[])">
|
|
<param name="getProc">To be added.</param>
|
|
<param name="vkInstance">To be added.</param>
|
|
<param name="vkPhysicalDevice">To be added.</param>
|
|
<param name="instanceExtensions">To be added.</param>
|
|
<param name="deviceExtensions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRVkGetProcedureAddressDelegate">
|
|
<param name="name">To be added.</param>
|
|
<param name="instance">To be added.</param>
|
|
<param name="device">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GRVkImageInfo">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.Alloc">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.CurrentQueueFamily">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkImageInfo.Equals(SkiaSharp.GRVkImageInfo)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkImageInfo.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.Format">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkImageInfo.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.Image">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.ImageLayout">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.ImageTiling">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.ImageUsageFlags">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.LevelCount">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkImageInfo.op_Equality(SkiaSharp.GRVkImageInfo,SkiaSharp.GRVkImageInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GRVkImageInfo.op_Inequality(SkiaSharp.GRVkImageInfo,SkiaSharp.GRVkImageInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.Protected">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.SampleCount">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.SharingMode">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GRVkImageInfo.YcbcrConversionInfo">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.GrVkYcbcrConversionInfo">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GrVkYcbcrConversionInfo.ChromaFilter">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GrVkYcbcrConversionInfo.Equals(SkiaSharp.GrVkYcbcrConversionInfo)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GrVkYcbcrConversionInfo.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GrVkYcbcrConversionInfo.ExternalFormat">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GrVkYcbcrConversionInfo.ForceExplicitReconstruction">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GrVkYcbcrConversionInfo.Format">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GrVkYcbcrConversionInfo.FormatFeatures">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GrVkYcbcrConversionInfo.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GrVkYcbcrConversionInfo.op_Equality(SkiaSharp.GrVkYcbcrConversionInfo,SkiaSharp.GrVkYcbcrConversionInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.GrVkYcbcrConversionInfo.op_Inequality(SkiaSharp.GrVkYcbcrConversionInfo,SkiaSharp.GrVkYcbcrConversionInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GrVkYcbcrConversionInfo.XChromaOffset">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GrVkYcbcrConversionInfo.YcbcrModel">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GrVkYcbcrConversionInfo.YcbcrRange">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.GrVkYcbcrConversionInfo.YChromaOffset">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SK3dView">
|
|
<summary>A utility class that can be used to create 3D transformations.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SK3dView">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SK3dView" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.ApplyToCanvas(SkiaSharp.SKCanvas)">
|
|
<param name="canvas">The canvas to apply the transformation to.</param>
|
|
<summary>Applies the current transformation to the specified canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SK3dView" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SK3dView" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.DotWithNormal(System.Single,System.Single,System.Single)">
|
|
<param name="dx">The x-axis of the normal.</param>
|
|
<param name="dy">The y-axis of the normal.</param>
|
|
<param name="dz">The z-axis of the normal.</param>
|
|
<summary>Returns the dot product of the current transformation and the specified normal.</summary>
|
|
<returns>Returns the dot product.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.GetMatrix(SkiaSharp.SKMatrix@)">
|
|
<param name="matrix">The matrix to store the transformation.</param>
|
|
<summary>Stores the current transformation in the specified matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SK3dView.Matrix">
|
|
<summary>Gets the current transformation as a matrix.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.Restore">
|
|
<summary>Restores the transformation to the last saved with <see cref="M:SkiaSharp.SK3dView.Save" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.RotateXDegrees(System.Single)">
|
|
<param name="degrees">The degrees to rotate by.</param>
|
|
<summary>Rotates the transformation along the x-axis by the specified degrees.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.RotateXRadians(System.Single)">
|
|
<param name="radians">The radians to rotate by.</param>
|
|
<summary>Rotates the transformation along the x-axis by the specified radians.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.RotateYDegrees(System.Single)">
|
|
<param name="degrees">The degrees to rotate by.</param>
|
|
<summary>Rotates the transformation along the y-axis by the specified degrees.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.RotateYRadians(System.Single)">
|
|
<param name="radians">The radians to rotate by.</param>
|
|
<summary>Rotates the transformation along the y-axis by the specified radians.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.RotateZDegrees(System.Single)">
|
|
<param name="degrees">The degrees to rotate by.</param>
|
|
<summary>Rotates the transformation along the z-axis by the specified degrees.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.RotateZRadians(System.Single)">
|
|
<param name="radians">The radians to rotate by.</param>
|
|
<summary>Rotates the transformation along the z-axis by the specified radians.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.Save">
|
|
<summary>Saves the current transformation so that it can be restored later using <see cref="M:SkiaSharp.SK3dView.Restore" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.Translate(System.Single,System.Single,System.Single)">
|
|
<param name="x">The amount to translate by along the x-axis.</param>
|
|
<param name="y">The amount to translate by along the y-axis.</param>
|
|
<param name="z">The amount to translate by along the z-axis.</param>
|
|
<summary>Translates the transformation.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.TranslateX(System.Single)">
|
|
<param name="x">The amount to translate by.</param>
|
|
<summary>Translates the transformation along the x-axis.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.TranslateY(System.Single)">
|
|
<param name="y">The amount to translate by.</param>
|
|
<summary>Translates the transformation along the y-axis.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SK3dView.TranslateZ(System.Single)">
|
|
<param name="z">The amount to translate by.</param>
|
|
<summary>Translates the transformation along the z-axis.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKAbstractManagedStream">
|
|
<summary>Represents a <see cref="T:SkiaSharp.SKStreamAsset" /> (a seekable, rewindable Skia stream).</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKAbstractManagedStream">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKAbstractManagedStream" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKAbstractManagedStream(System.Boolean)">
|
|
<param name="owns">The value indicating whether this object should destroy the underlying native object.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKAbstractManagedStream" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKAbstractManagedStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKAbstractManagedStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnCreateNew">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to copy the current stream.</summary>
|
|
<returns>Returns a pointer to the new <see cref="T:SkiaSharp.SKStreamAsset" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnDuplicate">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to duplicate the current stream.</summary>
|
|
<returns>Returns a pointer to the new <see cref="T:SkiaSharp.SKStreamAsset" /> instance.</returns>
|
|
<remarks>After the stream has been duplicated, the new stream must set it's position to the start.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnFork">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to fork the current stream.</summary>
|
|
<returns>Returns a pointer to the new <see cref="T:SkiaSharp.SKStreamAsset" /> instance.</returns>
|
|
<remarks>After the stream has been duplicated, the new stream must set it's position to the same as this stream.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnGetLength">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to return the total length of the stream.</summary>
|
|
<returns>Returns the total length of the stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnGetPosition">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to get the current position in the stream</summary>
|
|
<returns>Returns the current position in the stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnHasLength">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to indicate whether this stream can report it's total length.</summary>
|
|
<returns>Returns a value indicating whether this stream can report it's total length.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnHasPosition">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to indicate whether this stream can report it's current position.</summary>
|
|
<returns>Returns a value indicating whether this stream can report it's current position.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnIsAtEnd">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to indicate whether all the bytes in the stream have been read.</summary>
|
|
<returns>Returns a value indicating whether all the bytes in the stream have been read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnMove(System.Int32)">
|
|
<param name="offset">The relative offset.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to seek to a relative offset.</summary>
|
|
<returns>Returns true if seeking is supported and the seek was successful, otherwise false.</returns>
|
|
<remarks>If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnPeek(System.IntPtr,System.IntPtr)">
|
|
<param name="buffer">The buffer to read into.</param>
|
|
<param name="size">The number of bytes to read.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to copy the specified number of bytes into the specified buffer.</summary>
|
|
<returns>Returns the number of bytes actually peeked/copied.</returns>
|
|
<remarks>The stream's cursor must be returned to the position before this method was called.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnRead(System.IntPtr,System.IntPtr)">
|
|
<param name="buffer">The buffer to read into.</param>
|
|
<param name="size">The number of bytes to read.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to copy the specified number of bytes into the specified buffer.</summary>
|
|
<returns>Returns the number of bytes actually read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnRewind">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to rewind the current stream.</summary>
|
|
<returns>Returns true if the stream is known to be at the beginning after this call returns.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedStream.OnSeek(System.IntPtr)">
|
|
<param name="position">The absolute position.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to seek to an absolute position.</summary>
|
|
<returns>Returns true if seeking is supported and the seek was successful, otherwise false.</returns>
|
|
<remarks>If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end).</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKAbstractManagedWStream">
|
|
<summary>Represents a <see cref="T:SkiaSharp.SKWStream" /> (a writeable Skia stream).</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKAbstractManagedWStream">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKAbstractManagedWStream" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKAbstractManagedWStream(System.Boolean)">
|
|
<param name="owns">The value indicating whether this object should destroy the underlying native object.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKAbstractManagedWStream" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedWStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKAbstractManagedWStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedWStream.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedWStream.OnBytesWritten">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to specify the number of bytes currently written to the stream.</summary>
|
|
<returns>Returns the number of bytes currently written to the stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedWStream.OnFlush">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to flush the bytes to the underlying stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAbstractManagedWStream.OnWrite(System.IntPtr,System.IntPtr)">
|
|
<param name="buffer">The buffer to copy into the underlying stream.</param>
|
|
<param name="size">The number of bytes to copy from the buffer.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to copy the specified number of bytes from the specified buffer into the underlying stream.</summary>
|
|
<returns>Returns <see langword="true" /> on success, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKAlphaType">
|
|
<summary>Describes how to interpret the alpha component of a pixel.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKAlphaType.Opaque">
|
|
<summary>All pixels are stored as opaque.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKAlphaType.Premul">
|
|
<summary>
|
|
<para>All pixels have their alpha premultiplied in their color components.</para>
|
|
<para>This is the natural format for the rendering target pixels.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKAlphaType.Unknown">
|
|
<summary />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKAlphaType.Unpremul">
|
|
<summary>
|
|
<para>All pixels have their color components stored without any regard to the alpha. e.g. this is the default configuration for PNG images.</para>
|
|
<para>This alpha-type is ONLY supported for input images. Rendering cannot generate this on output.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKAutoCanvasRestore">
|
|
<summary>Convenience class used to restore the canvas state in a using statement.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This class can be used in a using statement to save the state of the canvas
|
|
(matrix, clip and draw filter) allowing you to change these components and have
|
|
them automatically undone by virtue of having the
|
|
<xref:SkiaSharp.SKAutoCanvasRestore.Dispose> method restore the canvas state to
|
|
the state it was when this instance was created.
|
|
|
|
## Examples
|
|
|
|
```csharp
|
|
SKCanvas canvas = ...;
|
|
|
|
using (new SKAutoCanvasRestore(canvas)) {
|
|
// perform some transform
|
|
canvas.RotateDegrees(45);
|
|
|
|
// draw as usual
|
|
var paint = new SKPaint ();
|
|
canavs.DrawRect (10, 10, 100, 100, paint);
|
|
|
|
// automatically restore to original transform
|
|
}
|
|
```
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKAutoCanvasRestore(SkiaSharp.SKCanvas)">
|
|
<param name="canvas">The canvas whose state will be preserved.</param>
|
|
<summary>Creates a canvas restore point, invoking the <see cref="M:SkiaSharp.SKCanvas.Save" /> method.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKAutoCanvasRestore(SkiaSharp.SKCanvas,System.Boolean)">
|
|
<param name="canvas">The canvas whose state will be preserved.</param>
|
|
<param name="doSave">Whether or not to invoke <see cref="M:SkiaSharp.SKCanvas.Save" /> method at this point.</param>
|
|
<summary>Creates a canvas restore point.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAutoCanvasRestore.Dispose">
|
|
<summary>
|
|
<para>Disposes the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was created.</para>
|
|
<para>This operation will not do anything if you had previously manually called the <see cref="M:SkiaSharp.SKAutoCanvasRestore.Restore" /> method.</para>
|
|
</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAutoCanvasRestore.Restore">
|
|
<summary>Restores the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was creatd.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKAutoCoInitialize">
|
|
<summary>Convenience class used to automatically initialize and uninitialize COM on supported platforms.</summary>
|
|
<remarks>
|
|
<para>This is only supported on Windows, and is usually not needed. However, when creating a .NET Core app, COM may not be initialized.</para>
|
|
<para>Currently, only <see cref="T:SkiaSharp.SKDocument" /> and more specifically, XPS documents require COM.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKAutoCoInitialize">
|
|
<summary>Initializes COM.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAutoCoInitialize.Dispose">
|
|
<summary>Uninitializes COM.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKAutoCoInitialize.Initialized">
|
|
<summary>Gets a value indicating whether COM is initialized or not.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAutoCoInitialize.Uninitialize">
|
|
<summary>Uninitializes COM.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKAutoMaskFreeImage">
|
|
<summary>Convenience class used to automatically free the image data for a mask in a using statement.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This class can be used in a using statement to automatically free the image
|
|
data of a mask by virtue of having the
|
|
<xref:SkiaSharp.SKAutoMaskFreeImage.Dispose> method.
|
|
|
|
## Examples
|
|
|
|
```csharp
|
|
// some buffer
|
|
byte[] buffer = ...;
|
|
|
|
// create the mask, allocating the image
|
|
var mask = SKMask.Create(buffer, bounds, rowBytes, format);
|
|
using (new SKAutoMaskFreeImage(mask.Image)) {
|
|
// use the mask
|
|
|
|
// automatically release the image data
|
|
}
|
|
```
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKAutoMaskFreeImage(System.IntPtr)">
|
|
<param name="maskImage">The image to free.</param>
|
|
<summary>Create a new instance of <see cref="T:SkiaSharp.SKAutoMaskFreeImage" /> with the specified image to free.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKAutoMaskFreeImage.Dispose">
|
|
<summary>Disposes the object, releasing the image data.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKBitmap">
|
|
<summary>The <see cref="T:SkiaSharp.SKBitmap" /> specifies a raster bitmap.</summary>
|
|
<remarks>
|
|
<para>A bitmap has an integer width and height, and a format (color type), and a pointer to the actual pixels. Bitmaps can be drawn into a <see cref="T:SkiaSharp.SKCanvas" />, but they are also used to specify the target of a <see cref="T:SkiaSharp.SKCanvas" />' drawing operations.</para>
|
|
<para>A <see cref="T:SkiaSharp.SKBitmap" /> exposes <see cref="M:SkiaSharp.SKBitmap.GetPixels" />, which lets a caller write its pixels. To retrieve a pointer to the raw image data of the bitmap, call the <see cref="M:SkiaSharp.SKBitmap.LockPixels" /> method, and then call the <see cref="M:SkiaSharp.SKBitmap.GetPixels" /> method to get a pointer to the image data. Once you no longer need to use the raw data pointer, call the <see cref="M:SkiaSharp.SKBitmap.UnlockPixels" /> method. The raw data is laid out in the format configured at the time that the bitmap was created.</para>
|
|
<para>(Note: As of SkiaSharp 1.60.0, calls to <see cref="M:SkiaSharp.SKBitmap.LockPixels" /> and <see cref="M:SkiaSharp.SKBitmap.UnlockPixels" /> are no longer required, and they no longer exist as part of the API.)</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKBitmap">
|
|
<summary>Default constructor that creates a bitmap with zero width and height, and no pixels. Its color type is set to <see cref="F:SkiaSharp.SKColorType.Unknown" />.</summary>
|
|
<remarks>This constructor does not allocate a backing store for the bitmap.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKBitmap(SkiaSharp.SKImageInfo)">
|
|
<param name="info">The description of the desired image format.</param>
|
|
<summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification.</summary>
|
|
<remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKBitmap(SkiaSharp.SKImageInfo,SkiaSharp.SKBitmapAllocFlags)">
|
|
<param name="info">The description of the desired image format.</param>
|
|
<param name="flags">The additional flags.</param>
|
|
<summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification.</summary>
|
|
<remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKBitmap(SkiaSharp.SKImageInfo,SkiaSharp.SKColorTable)">
|
|
<param name="info">The description of the desired image format.</param>
|
|
<param name="ctable">The color lookup table.</param>
|
|
<summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification and a color table.</summary>
|
|
<remarks>Use this method to create a bitmap that will use a color lookup table. The bitmap will be an 8-bit indexed bitmap, where each value represents an index into the color table, and the color is determined by the value in the specific location in the color table array.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKBitmap(SkiaSharp.SKImageInfo,System.Int32)">
|
|
<param name="info">The description of the desired image format.</param>
|
|
<param name="rowBytes">The number of bytes per row.</param>
|
|
<summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification, and the specified number of bytes per row (the stride size)</summary>
|
|
<remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKBitmap(SkiaSharp.SKImageInfo,SkiaSharp.SKColorTable,SkiaSharp.SKBitmapAllocFlags)">
|
|
<param name="info">The description of the desired image format.</param>
|
|
<param name="ctable">The color lookup table.</param>
|
|
<param name="flags">The additional flags.</param>
|
|
<summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification and a color table.</summary>
|
|
<remarks>Use this method to create a bitmap that will use a color lookup table. The bitmap will be an 8-bit indexed bitmap, where each value represents an index into the color table, and the color is determined by the value in the specific location in the color table array.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKBitmap(System.Int32,System.Int32,System.Boolean)">
|
|
<param name="width">The desired width in pixels.</param>
|
|
<param name="height">The desired height in pixels.</param>
|
|
<param name="isOpaque">If true, sets the <see cref="T:SkiaSharp.SKAlphaType" /> to <see cref="F:SkiaSharp.SKAlphaType.Opaque" />, otherwise it sets it to <see cref="F:SkiaSharp.SKAlphaType.Premul" />.</param>
|
|
<summary>Creates a bitmap with the given width, height and opacity with color type set to <see cref="F:SkiaSharp.SKImageInfo.PlatformColorType" /></summary>
|
|
<remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKBitmap(System.Int32,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType)">
|
|
<param name="width">The desired width in pixels.</param>
|
|
<param name="height">The desired height in pixels.</param>
|
|
<param name="colorType">The desired <see cref="T:SkiaSharp.SKColorType" />.</param>
|
|
<param name="alphaType">The desired <see cref="T:SkiaSharp.SKAlphaType" />.</param>
|
|
<summary>Creates a bitmap with the given width, height, color type and alpha type.</summary>
|
|
<remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKBitmap(System.Int32,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace)">
|
|
<param name="width">To be added.</param>
|
|
<param name="height">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="alphaType">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.AlphaType">
|
|
<summary>Gets the configured <see cref="T:SkiaSharp.SKAlphaType" /> for the bitmap.</summary>
|
|
<value>The configured <see cref="T:SkiaSharp.SKAlphaType" />.</value>
|
|
<remarks>This determines the kind of encoding used for the alpha channel, opaque, premultiplied or unpremultiplied.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.ByteCount">
|
|
<summary>Returns the byte size of the pixels, based on the <see cref="P:SkiaSharp.SKBitmap.Height" /> and <see cref="P:SkiaSharp.SKBitmap.RowBytes" />.</summary>
|
|
<value>The byte size of the pixels.</value>
|
|
<remarks>Note: this truncates the result to 32-bits.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.Bytes">
|
|
<summary>Gets a copy of all the pixel data as a byte array.</summary>
|
|
<value>The pixel data.</value>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.BytesPerPixel">
|
|
<summary>Gets the number of bytes used per pixel.</summary>
|
|
<value />
|
|
<remarks>This is calculated from the <see cref="P:SkiaSharp.SKBitmap.ColorType" />. If the color type is <see cref="F:SkiaSharp.SKColorType.Unknown" />, then the value will be 0.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.CanCopyTo(SkiaSharp.SKColorType)">
|
|
<param name="colorType">The color type to check with.</param>
|
|
<summary>Returns true if this bitmap's pixels can be converted into the requested color type, such that <see cref="M:SkiaSharp.SKBitmap.Copy" /> or <see cref="M:SkiaSharp.SKBitmap.CopyTo(SkiaSharp.SKBitmap)" /> could succeed.</summary>
|
|
<returns>Returns true if this bitmap's pixels can be converted into the requested color type.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.ColorSpace">
|
|
<summary>Gets the color space of the bitmap.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.ColorTable">
|
|
<summary>Gets the color table of the bitmap.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.ColorType">
|
|
<summary>Gets the color type of the bitmap.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Copy">
|
|
<summary>Copies the contents of the bitmap and returns the copy.</summary>
|
|
<returns>The copy of the bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Copy(SkiaSharp.SKColorType)">
|
|
<param name="colorType">The color type to use for the copy of the bitmap.</param>
|
|
<summary>Copies the contents of the bitmap with the specified color type and returns the copy.</summary>
|
|
<returns>The copy of the bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.CopyTo(SkiaSharp.SKBitmap)">
|
|
<param name="destination">The bitmap to received the copied contents.</param>
|
|
<summary>Copies the contents of the bitmap into the specified bitmap.</summary>
|
|
<returns>Returns true if the copy was made.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.CopyTo(SkiaSharp.SKBitmap,SkiaSharp.SKColorType)">
|
|
<param name="destination">The bitmap to received the copied contents.</param>
|
|
<param name="colorType">The color type to use for the copy of the bitmap.</param>
|
|
<summary>Copies the contents of the bitmap into the specified bitmap.</summary>
|
|
<returns>Returns true if the copy was made.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(SkiaSharp.SKCodec)">
|
|
<param name="codec">The codec to decode.</param>
|
|
<summary>Decode a bitmap using the specified codec.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(SkiaSharp.SKData)">
|
|
<param name="data">The data to decode.</param>
|
|
<summary>Decode a bitmap using the specified data.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(SkiaSharp.SKStream)">
|
|
<param name="stream">The stream to decode.</param>
|
|
<summary>Decode a bitmap using the specified stream.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(System.Byte[])">
|
|
<param name="buffer">The byte buffer to decode.</param>
|
|
<summary>Decode a bitmap using the specified byte buffer.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(System.IO.Stream)">
|
|
<param name="stream">The stream to decode.</param>
|
|
<summary>Decode a bitmap using the specified stream and destination image information.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(System.ReadOnlySpan{System.Byte})">
|
|
<param name="buffer">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(System.String)">
|
|
<param name="filename">The filename of the bitmap to decode.</param>
|
|
<summary>Decode a bitmap for the specified filename.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(SkiaSharp.SKCodec,SkiaSharp.SKImageInfo)">
|
|
<param name="codec">The codec to decode.</param>
|
|
<param name="bitmapInfo">The destination image information.</param>
|
|
<summary>Decode a bitmap using the specified codec and destination image information.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(SkiaSharp.SKData,SkiaSharp.SKImageInfo)">
|
|
<param name="data">The data to decode.</param>
|
|
<param name="bitmapInfo">The destination image information.</param>
|
|
<summary>Decode a bitmap using the specified data and destination image information.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(SkiaSharp.SKStream,SkiaSharp.SKImageInfo)">
|
|
<param name="stream">The stream to decode.</param>
|
|
<param name="bitmapInfo">The destination image information.</param>
|
|
<summary>Decode a bitmap using the specified stream and destination image information.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(System.Byte[],SkiaSharp.SKImageInfo)">
|
|
<param name="buffer">The byte buffer to decode.</param>
|
|
<param name="bitmapInfo">The destination image information.</param>
|
|
<summary>Decode a bitmap using the specified byte buffer and destination image information.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(System.IO.Stream,SkiaSharp.SKImageInfo)">
|
|
<param name="stream">The stream to decode.</param>
|
|
<param name="bitmapInfo">The destination image information.</param>
|
|
<summary>Decode a bitmap using the specified stream and destination image information.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(System.ReadOnlySpan{System.Byte},SkiaSharp.SKImageInfo)">
|
|
<param name="buffer">To be added.</param>
|
|
<param name="bitmapInfo">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Decode(System.String,SkiaSharp.SKImageInfo)">
|
|
<param name="filename">The filename of the bitmap to decode.</param>
|
|
<param name="bitmapInfo">The destination image information.</param>
|
|
<summary>Decode a bitmap for the specified filename and destination image information.</summary>
|
|
<returns>The decoded bitmap, or <paramref name="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.DecodeBounds(SkiaSharp.SKData)">
|
|
<param name="data">The data to decode.</param>
|
|
<summary>Decode the bitmap information using the specified data.</summary>
|
|
<returns>The decoded bitmap information, or <see cref="F:SkiaSharp.SKImageInfo.Empty" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.DecodeBounds(SkiaSharp.SKStream)">
|
|
<param name="stream">The stream to decode.</param>
|
|
<summary>Decode the bitmap information using the specified stream.</summary>
|
|
<returns>The decoded bitmap information, or <see cref="F:SkiaSharp.SKImageInfo.Empty" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.DecodeBounds(System.Byte[])">
|
|
<param name="buffer">The byte buffer to decode.</param>
|
|
<summary>Decode the bitmap information using the specified byte buffer.</summary>
|
|
<returns>The decoded bitmap information, or <see cref="F:SkiaSharp.SKImageInfo.Empty" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.DecodeBounds(System.IO.Stream)">
|
|
<param name="stream">The stream to decode.</param>
|
|
<summary>Decode the bitmap information using the specified stream.</summary>
|
|
<returns>The decoded bitmap information, or <see cref="F:SkiaSharp.SKImageInfo.Empty" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.DecodeBounds(System.ReadOnlySpan{System.Byte})">
|
|
<param name="buffer">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.DecodeBounds(System.String)">
|
|
<param name="filename">The filename of the bitmap to decode.</param>
|
|
<summary>Decode the bitmap information for the specified filename.</summary>
|
|
<returns>The decoded bitmap information, or <see cref="F:SkiaSharp.SKImageInfo.Empty" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKBitmap" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKBitmap" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.DrawsNothing">
|
|
<summary>Gets a value indicating whether drawing this bitmap has any effect.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Encode(SkiaSharp.SKEncodedImageFormat,System.Int32)">
|
|
<param name="format">To be added.</param>
|
|
<param name="quality">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKEncodedImageFormat,System.Int32)">
|
|
<param name="dst">The stream to write the encoded image to.</param>
|
|
<param name="format">The file format used to encode the image.</param>
|
|
<param name="quality">The quality level to use for the image.</param>
|
|
<summary>Encodes the image using the specified format.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Encode(System.IO.Stream,SkiaSharp.SKEncodedImageFormat,System.Int32)">
|
|
<param name="dst">To be added.</param>
|
|
<param name="format">To be added.</param>
|
|
<param name="quality">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Erase(SkiaSharp.SKColor)">
|
|
<param name="color">The color to fill.</param>
|
|
<summary>Fill the entire bitmap with the specified color.</summary>
|
|
<remarks>If the bitmap's color type does not support alpha (e.g. 565) then the alpha of the color is ignored (treated as opaque). If the color type only supports alpha (e.g. A1 or A8) then the color's R, G, B components are ignored.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Erase(SkiaSharp.SKColor,SkiaSharp.SKRectI)">
|
|
<param name="color">The color to fill.</param>
|
|
<param name="rect">The area to fill.</param>
|
|
<summary>Fill the specified area of this bitmap with the specified color.</summary>
|
|
<remarks>If the bitmap's color type does not support alpha (e.g. 565) then the alpha of the color is ignored (treated as opaque). If the color type only supports alpha (e.g. A1 or A8) then the color's R, G, B components are ignored.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ExtractAlpha(SkiaSharp.SKBitmap)">
|
|
<param name="destination">The bitmap to be filled with alpha layer.</param>
|
|
<summary>Retrieve the alpha layer of this bitmap.</summary>
|
|
<returns>Returns true if the alpha layer was retrieved, false otherwise.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ExtractAlpha(SkiaSharp.SKBitmap,SkiaSharp.SKPaint)">
|
|
<param name="destination">The bitmap to be filled with alpha layer.</param>
|
|
<param name="paint">The paint to draw with.</param>
|
|
<summary>Retrieve the alpha layer of this bitmap after applying the specified paint.</summary>
|
|
<returns>Returns true if the alpha layer was retrieved, false otherwise.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ExtractAlpha(SkiaSharp.SKBitmap,SkiaSharp.SKPointI@)">
|
|
<param name="destination">The bitmap to be filled with alpha layer.</param>
|
|
<param name="offset">The top-left coordinate to position the retrieved bitmap so that it visually lines up with the original.</param>
|
|
<summary>Retrieve the alpha layer of this bitmap.</summary>
|
|
<returns>Returns true if the alpha layer was retrieved, false otherwise.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ExtractAlpha(SkiaSharp.SKBitmap,SkiaSharp.SKPaint,SkiaSharp.SKPointI@)">
|
|
<param name="destination">The bitmap to be filled with alpha layer.</param>
|
|
<param name="paint">The paint to draw with.</param>
|
|
<param name="offset">The top-left coordinate to position the retrieved bitmap so that it visually lines up with the original.</param>
|
|
<summary>Retrieve the alpha layer of this bitmap after applying the specified paint.</summary>
|
|
<returns>Returns true if the alpha layer was retrieved, false otherwise.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ExtractSubset(SkiaSharp.SKBitmap,SkiaSharp.SKRectI)">
|
|
<param name="destination">The bitmap that will be set to a subset of this bitmap.</param>
|
|
<param name="subset">The rectangle of pixels in this bitmap that the destination will reference.</param>
|
|
<summary>Retrieve a subset of this bitmap.</summary>
|
|
<returns>Returns true if the subset was retrieved, false otherwise.</returns>
|
|
<remarks>If possible, the retrieved bitmap will share the pixel memory, and just point into a subset of it. However, if the color type does not support this, a local copy will be made and associated with the destination bitmap.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.FromImage(SkiaSharp.SKImage)">
|
|
<param name="image">The image to use to create a bitmap.</param>
|
|
<summary>Creates a new bitmap from a copy of the pixel data in the specified image.</summary>
|
|
<returns>Returns a new instance of <see cref="T:SkiaSharp.SKBitmap" />, or null if the bitmap could not be created.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetAddr(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate of the pixel.</param>
|
|
<param name="y">The y-coordinate of the pixel.</param>
|
|
<summary>Returns the address of the specified pixel.</summary>
|
|
<returns>Returns the address of the specified pixel.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetAddr16(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate of the pixel.</param>
|
|
<param name="y">The y-coordinate of the pixel.</param>
|
|
<summary>Returns the 16-bit value of the specified pixel.</summary>
|
|
<returns>Returns the 16-bit value of the specified pixel.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetAddr32(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate of the pixel.</param>
|
|
<param name="y">The y-coordinate of the pixel.</param>
|
|
<summary>Returns the 32-bit value of the specified pixel.</summary>
|
|
<returns>Returns the 32-bit value of the specified pixel.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetAddr8(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate of the pixel.</param>
|
|
<param name="y">The y-coordinate of the pixel.</param>
|
|
<summary>Returns the 8-bit value of the specified pixel.</summary>
|
|
<returns>Returns the 8-bit value of the specified pixel.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetAddress(System.Int32,System.Int32)">
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetIndex8Color(System.Int32,System.Int32)">
|
|
<param name="x">The x-cordinate.</param>
|
|
<param name="y">The y-cordinate.</param>
|
|
<summary>Returns the color corresponding to the pixel specified by the coordinates for palette-based (color table) bitmaps.</summary>
|
|
<returns>Returns the color corresponding to the pixel specified by the coordinates.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetPixel(System.Int32,System.Int32)">
|
|
<param name="x">The x-cordinate.</param>
|
|
<param name="y">The y-cordinate.</param>
|
|
<summary>Returns the color for the pixel at the specified location.</summary>
|
|
<returns>Alpha only color types return black with the appropriate alpha set. The value is undefined for <see cref="F:SkiaSharp.SKColorType.Unknown" />, if the coordinates are out of bounds, if the bitmap does not have any pixels, or has not be locked with <see cref="M:SkiaSharp.SKBitmap.LockPixels" />.</returns>
|
|
<remarks>In most cases this will require unpremultiplying the color.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetPixels">
|
|
<summary>Returns the address of the pixels for this bitmap.</summary>
|
|
<returns>Returns a pointer to the region that contains the pixel data for this bitmap. This might return <see langword="IntPtr.Zero" /> if there is no pixel buffer associated with this bitmap.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetPixels(System.IntPtr@)">
|
|
<param name="length">The length of the pixel buffer of the bitmap.</param>
|
|
<summary>Returns the address of the pixels for this bitmap.</summary>
|
|
<returns>Returns a pointer to the region that contains the pixel data for this bitmap. This might return <see langword="IntPtr.Zero" /> if there is no pixel buffer associated with this bitmap.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.GetPixelSpan">
|
|
<summary>Returns a span that wraps the pixel data.</summary>
|
|
<returns>Returns the span.</returns>
|
|
<remarks>This span is only valid as long as the bitmap is valid</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.Height">
|
|
<summary>Gets the height of the bitmap.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.Info">
|
|
<summary>Gets an instance of <see cref="T:SkiaSharp.SKImageInfo" /> with all the properties of the bitmap.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.InstallMaskPixels(SkiaSharp.SKMask)">
|
|
<param name="mask">The mask to install.</param>
|
|
<summary>Installs the specified mask's pixels into the bitmap.</summary>
|
|
<returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
|
|
<remarks>The caller must ensure that the specified mask pixels are valid for the lifetime of the created bitmap.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.InstallPixels(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixels to install.</param>
|
|
<summary>Installs the specified pixels into the bitmap.</summary>
|
|
<returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.InstallPixels(SkiaSharp.SKImageInfo,System.IntPtr)">
|
|
<param name="info">The image information describing the pixels.</param>
|
|
<param name="pixels">The pixels to install.</param>
|
|
<summary>Installs the specified pixels into the bitmap.</summary>
|
|
<returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.InstallPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)">
|
|
<param name="info">The image information describing the pixels.</param>
|
|
<param name="pixels">The pixels to install.</param>
|
|
<param name="rowBytes">The stride of the pixels being installed.</param>
|
|
<summary>Installs the specified pixels into the bitmap.</summary>
|
|
<returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.InstallPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKBitmapReleaseDelegate)">
|
|
<param name="info">The image information describing the pixels.</param>
|
|
<param name="pixels">The pixels to install.</param>
|
|
<param name="rowBytes">The stride of the pixels being installed.</param>
|
|
<param name="releaseProc">The delegate to invoke when the pixels are no longer referenced.</param>
|
|
<summary>Installs the specified pixels into the bitmap.</summary>
|
|
<returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.InstallPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKColorTable)">
|
|
<param name="info">The image information describing the pixels.</param>
|
|
<param name="pixels">The pixels to install.</param>
|
|
<param name="rowBytes">The stride of the pixels being installed.</param>
|
|
<param name="ctable">The color table to use, if installing Index8 pixels.</param>
|
|
<summary>Installs the specified pixels into the bitmap.</summary>
|
|
<returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.InstallPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKBitmapReleaseDelegate,System.Object)">
|
|
<param name="info">The image information describing the pixels.</param>
|
|
<param name="pixels">The pixels to install.</param>
|
|
<param name="rowBytes">The stride of the pixels being installed.</param>
|
|
<param name="releaseProc">The delegate to invoke when the pixels are no longer referenced.</param>
|
|
<param name="context">The user data to use when invoking the delegate.</param>
|
|
<summary>Installs the specified pixels into the bitmap.</summary>
|
|
<returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.InstallPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKColorTable,SkiaSharp.SKBitmapReleaseDelegate,System.Object)">
|
|
<param name="info">The image information describing the pixels.</param>
|
|
<param name="pixels">The pixels to install.</param>
|
|
<param name="rowBytes">The stride of the pixels being installed.</param>
|
|
<param name="ctable">Pixel8 is no longer supported.</param>
|
|
<param name="releaseProc">The delegate to invoke when the pixels are no longer referenced.</param>
|
|
<param name="context">The user data to use when invoking the delegate.</param>
|
|
<summary>Developers should not use this obsolete method.</summary>
|
|
<returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.IsEmpty">
|
|
<summary>Gets a value indicating whether the bitmap has empty dimensions.</summary>
|
|
<value />
|
|
<remarks>In most cases, <see cref="P:SkiaSharp.SKBitmap.DrawsNothing" /> will return the desired result as it checks <see cref="P:SkiaSharp.SKBitmap.IsNull" /> as well.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.IsImmutable">
|
|
<summary>Indicates if the bitmap contents are immutable.</summary>
|
|
<value>Returns <see langword="true" /> if it is immutable, <see langword="false" /> otherwise.</value>
|
|
<remarks>Immutability means that the contents of its pixels will not change for the lifetime of the bitmap.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.IsNull">
|
|
<summary>Gets a value indicating whether the bitmap has any pixelref. </summary>
|
|
<value />
|
|
<remarks>This can return true even if the dimensions of the bitmap are not empty. In most cases, <see cref="P:SkiaSharp.SKBitmap.DrawsNothing" /> will return the desired result as it checks <see cref="P:SkiaSharp.SKBitmap.IsEmpty" /> as well.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.IsVolatile">
|
|
<summary>Gets a value indicating whether the bitmap should not be cached by devices.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.NotifyPixelsChanged">
|
|
<summary>Indicates to consumers of the bitmap that the pixel data has changed.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.PeekPixels">
|
|
<summary>Returns the pixels if they are available without having to lock the bitmap.</summary>
|
|
<returns>Returns the pixels if they are available, otherwise <see langword="null" />.</returns>
|
|
<remarks>If the pixels are available without locking, then the pixmap is only valid until the bitmap changes in any way, in which case the pixmap becomes invalid.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.PeekPixels(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixmap to receive the pixel information.</param>
|
|
<summary>Returns the pixmap of the bitmap.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if the bitmap does not have access to pixel data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.Pixels">
|
|
<summary>Gets all the pixels as an array of colors.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.ReadyToDraw">
|
|
<summary>Gets a value indicating whether or not the bitmap is valid enough to be drawn.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Reset">
|
|
<summary>Reset the bitmap to its initial state.</summary>
|
|
<remarks>The result is a bitmap with zero width and height, and no pixels. Its color type is set to <see cref="F:SkiaSharp.SKColorType.Unknown" />. If we are a (shared) owner of the pixels, that ownership is decremented.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Resize(SkiaSharp.SKBitmap,SkiaSharp.SKBitmapResizeMethod)">
|
|
<param name="dst">The bitmap to store the resized pixels.</param>
|
|
<param name="method">The resize method.</param>
|
|
<summary>Resizes the current bitmap using the specified resize method.</summary>
|
|
<returns>Returns <see langword="true" /> if the resize operation can be performed, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Resize(SkiaSharp.SKImageInfo,SkiaSharp.SKBitmapResizeMethod)">
|
|
<param name="info">The image information of the desired bitmap.</param>
|
|
<param name="method">The resize method.</param>
|
|
<summary>Resizes the current bitmap using the specified resize method.</summary>
|
|
<returns>Returns the resized bitmap if the resize operation could be performed, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Resize(SkiaSharp.SKImageInfo,SkiaSharp.SKFilterQuality)">
|
|
<param name="info">The image information of the desired bitmap.</param>
|
|
<param name="quality">The level of quality to use when scaling the pixels.</param>
|
|
<summary>Resizes the current bitmap using the specified quality filter.</summary>
|
|
<returns>Returns the resized bitmap if the resize operation could be performed, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Resize(SkiaSharp.SKSizeI,SkiaSharp.SKFilterQuality)">
|
|
<param name="size">To be added.</param>
|
|
<param name="quality">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.Resize(SkiaSharp.SKBitmap,SkiaSharp.SKBitmap,SkiaSharp.SKBitmapResizeMethod)">
|
|
<param name="dst">The bitmap to store the resized pixels.</param>
|
|
<param name="src">The bitmap to resize.</param>
|
|
<param name="method">The resize method.</param>
|
|
<summary>Resizes the provided bitmap using the specified resize method.</summary>
|
|
<returns>Returns <see langword="true" /> if the resize operation can be performed, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.RowBytes">
|
|
<summary>The number of bytes per row.</summary>
|
|
<value />
|
|
<remarks>The same as <see cref="P:SkiaSharp.SKImageInfo.RowBytes" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ScalePixels(SkiaSharp.SKBitmap,SkiaSharp.SKFilterQuality)">
|
|
<param name="destination">The bitmap to recieve the scaled and converted pixels.</param>
|
|
<param name="quality">The level of quality to use when scaling the pixels.</param>
|
|
<summary>Copies this pixmap to the destination, scaling the pixels to fit the destination size and converting the pixels to match the color type and alpha type.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Pixels are copied only if pixel conversion is possible.
|
|
|
|
If the color type is <xref:SkiaSharp.SKColorType.Gray8>, or
|
|
<xref:SkiaSharp.SKColorType.Alpha8>, the destination color type must match.
|
|
If the color type is <xref:SkiaSharp.SKColorType.Gray8>, destination
|
|
colorspace must also match.
|
|
|
|
If the alpha type is <xref:SkiaSharp.SKAlphaType.Opaque>, the destination
|
|
alpha type must match.
|
|
|
|
If the colorspace is `null`, the destination colorspace must also be `null`.
|
|
|
|
Filter Quality:
|
|
|
|
- <xref:SkiaSharp.SKFilterQuality.None> is fastest, typically implemented
|
|
with nearest neighbor filter.
|
|
- <xref:SkiaSharp.SKFilterQuality.Low> is typically implemented with bilerp
|
|
filter.
|
|
- <xref:SkiaSharp.SKFilterQuality.Medium> is typically implemented with
|
|
bilerp filter, and mipmap when size is reduced.
|
|
- <xref:SkiaSharp.SKFilterQuality.High> is slowest, typically implemented
|
|
with the bicubic filter.]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ScalePixels(SkiaSharp.SKPixmap,SkiaSharp.SKFilterQuality)">
|
|
<param name="destination">The pixmap to recieve the scaled and converted pixels.</param>
|
|
<param name="quality">The level of quality to use when scaling the pixels.</param>
|
|
<summary>Copies this pixmap to the destination, scaling the pixels to fit the destination size and converting the pixels to match the color type and alpha type.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Pixels are copied only if pixel conversion is possible.
|
|
|
|
If the color type is <xref:SkiaSharp.SKColorType.Gray8>, or
|
|
<xref:SkiaSharp.SKColorType.Alpha8>, the destination color type must match.
|
|
If the color type is <xref:SkiaSharp.SKColorType.Gray8>, destination
|
|
colorspace must also match.
|
|
|
|
If the alpha type is <xref:SkiaSharp.SKAlphaType.Opaque>, the destination
|
|
alpha type must match.
|
|
|
|
If the colorspace is `null`, the destination colorspace must also be `null`.
|
|
|
|
Filter Quality:
|
|
|
|
- <xref:SkiaSharp.SKFilterQuality.None> is fastest, typically implemented
|
|
with nearest neighbor filter.
|
|
- <xref:SkiaSharp.SKFilterQuality.Low> is typically implemented with bilerp
|
|
filter.
|
|
- <xref:SkiaSharp.SKFilterQuality.Medium> is typically implemented with
|
|
bilerp filter, and mipmap when size is reduced.
|
|
- <xref:SkiaSharp.SKFilterQuality.High> is slowest, typically implemented
|
|
with the bicubic filter.]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.SetColorTable(SkiaSharp.SKColorTable)">
|
|
<param name="ct">The new color table.</param>
|
|
<summary>Replaces the current color table of the bitmap.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.SetImmutable">
|
|
<summary>Marks the bitmap as immutable.</summary>
|
|
<remarks>Marks this bitmap as immutable, meaning that the contents of its pixels will not change for the lifetime of the bitmap and of the underlying pixelref. This state can be set, but it cannot be cleared once it is set. This state propagates to all other bitmaps that share the same pixelref.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.SetPixel(System.Int32,System.Int32,SkiaSharp.SKColor)">
|
|
<param name="x">The x-coordinate.</param>
|
|
<param name="y">The y-coordinate.</param>
|
|
<param name="color">The color to set.</param>
|
|
<summary>Sets the color of the pixel at a specified location.</summary>
|
|
<remarks>This method will set the color of the pixel on the bitmap to the specified <paramref name="color" /> performing any necessary color conversions to the format of the bitmap.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.SetPixels(System.IntPtr)">
|
|
<param name="pixels">The new pixel address.</param>
|
|
<summary>Replaces the current pixel address for the bitmap.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.SetPixels(System.IntPtr,SkiaSharp.SKColorTable)">
|
|
<param name="pixels">The new pixel address.</param>
|
|
<param name="ct">Index8 is no longer supported.</param>
|
|
<summary>Developers should not use this obsolete method.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ToShader">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ToShader(SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode)">
|
|
<param name="tmx">To be added.</param>
|
|
<param name="tmy">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.ToShader(SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="tmx">To be added.</param>
|
|
<param name="tmy">To be added.</param>
|
|
<param name="localMatrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.TryAllocPixels(SkiaSharp.SKImageInfo)">
|
|
<param name="info">The image information describing the pixels.</param>
|
|
<summary>Allocates the memory for the bitmap using the specified image information.</summary>
|
|
<returns>Returns true if the allocation was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.TryAllocPixels(SkiaSharp.SKImageInfo,SkiaSharp.SKBitmapAllocFlags)">
|
|
<param name="info">The image information describing the pixels.</param>
|
|
<param name="flags">The additional flags.</param>
|
|
<summary>Allocates the memory for the bitmap using the specified image information.</summary>
|
|
<returns>Returns true if the allocation was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKBitmap.TryAllocPixels(SkiaSharp.SKImageInfo,System.Int32)">
|
|
<param name="info">The image information describing the pixels.</param>
|
|
<param name="rowBytes">The stride of the pixels being allocated.</param>
|
|
<summary>Allocates the memory for the bitmap using the specified image information.</summary>
|
|
<returns>Returns true if the allocation was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKBitmap.Width">
|
|
<summary>Gets the width of the bitmap.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKBitmapAllocFlags">
|
|
<summary>Flags to use with <see cref="M:SkiaSharp.SKBitmap.#ctor" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBitmapAllocFlags.None">
|
|
<summary>Default bitmap allocation flag.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBitmapAllocFlags.ZeroPixels">
|
|
<summary>Initialize the bitmap with zeroed data.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKBitmapReleaseDelegate">
|
|
<param name="address">The memory address of the pixels being released.</param>
|
|
<param name="context">The user data that was provided when installing the pixels.</param>
|
|
<summary>The delegate that is used when releasing the memory for a bitmap.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKBitmapResizeMethod">
|
|
<summary>Channel selector type for the <see cref="M:SkiaSharp.SKBitmap.Resize(SkiaSharp.SKBitmap,SkiaSharp.SKBitmap,SkiaSharp.SKBitmapResizeMethod)" /> method or the <see cref="M:SkiaSharp.SKPixmap.Resize(SkiaSharp.SKPixmap,SkiaSharp.SKPixmap,SkiaSharp.SKBitmapResizeMethod)" /> method.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBitmapResizeMethod.Box">
|
|
<summary>Use the box interpolated filter (Shrink: average color; Grow: pixel replication).</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBitmapResizeMethod.Hamming">
|
|
<summary>Use the Hamming windowed Sinc filter (cosine bell variant).</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBitmapResizeMethod.Lanczos3">
|
|
<summary>Use the Lanczos windowed Sinc filter.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBitmapResizeMethod.Mitchell">
|
|
<summary>Use the Mitchell cubic filter.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBitmapResizeMethod.Triangle">
|
|
<summary>Use the box triangle or bilinear filter.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKBlendMode">
|
|
<summary>Predefined blend modes.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
- **Porter Duff Compositing Operators**
|
|
Defined algebra of compositing.
|
|
These operators control the results of mixing the four sub-pixel regions
|
|
formed by the overlapping of graphical objects that have an alpha or
|
|
pixel coverage channel/value.
|
|
- **Separable Blend Mode**
|
|
Each component of the result color is completely determined by the
|
|
corresponding components of the constituent backdrop and source colors.
|
|
- **Non-Separable Blend Mode**
|
|
Considers all color components in combination as opposed to the
|
|
separable ones that look at each component individually.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Clear">
|
|
<summary>No regions are enabled. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_clr.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Color">
|
|
<summary>Creates a color with the hue and saturation of the source color and the luminosity of the backdrop color. [Non-Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.ColorBurn">
|
|
<summary>Darkens the backdrop color to reflect the source color. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.ColorDodge">
|
|
<summary>Brightens the backdrop color to reflect the source color. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Darken">
|
|
<summary>Selects the darker of the backdrop and source colors. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Difference">
|
|
<summary>Subtracts the darker of the two constituent colors from the lighter color. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Dst">
|
|
<summary>Only the destination will be present. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.DstATop">
|
|
<summary>Destination which overlaps the source replaces the source. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst-atop.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.DstIn">
|
|
<summary>Destination which overlaps the source, replaces the source. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst-in.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.DstOut">
|
|
<summary>Destination is placed, where it falls outside of the source. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst-out.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.DstOver">
|
|
<summary>Destination is placed over the source. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst-over.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Exclusion">
|
|
<summary>Produces an effect similar to that of the Difference mode but lower in contrast. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.HardLight">
|
|
<summary>Multiplies or screens the colors, depending on the source color value. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Hue">
|
|
<summary>Creates a color with the hue of the source color and the saturation and luminosity of the backdrop color. [Non-Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Lighten">
|
|
<summary>Selects the lighter of the backdrop and source colors. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Luminosity">
|
|
<summary>Creates a color with the luminosity of the source color and the hue and saturation of the backdrop color. [Non-Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Modulate">
|
|
<summary>Multiplies all components (= alpha and color). [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Multiply">
|
|
<summary>The source color is multiplied by the destination color and replaces the destination [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Overlay">
|
|
<summary>Multiplies or screens the colors, depending on the backdrop color value. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Plus">
|
|
<summary>Display the sum of the source image and destination image. [Porter Duff Compositing Operators]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Saturation">
|
|
<summary>Creates a color with the saturation of the source color and the hue and luminosity of the backdrop color. [Non-Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Screen">
|
|
<summary>Multiplies the complements of the backdrop and source color values, then complements the result. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.SoftLight">
|
|
<summary>Darkens or lightens the colors, depending on the source color value. [Separable Blend Modes]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Src">
|
|
<summary>Only the source will be present. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.SrcATop">
|
|
<summary>Source which overlaps the destination, replaces the destination. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src-atop.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.SrcIn">
|
|
<summary>The source that overlaps the destination, replaces the destination. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src-in.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.SrcOut">
|
|
<summary>Source is placed, where it falls outside of the destination. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src-out.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.SrcOver">
|
|
<summary>Source is placed over the destination. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src-over.svg)</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlendMode.Xor">
|
|
<summary>The non-overlapping regions of source and destination are combined. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_xor.svg)</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKBlurMaskFilterFlags">
|
|
<summary>Flags to use with <see cref="M:SkiaSharp.SKMaskFilter.CreateBlur(SkiaSharp.SKBlurStyle,System.Single)" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlurMaskFilterFlags.All">
|
|
<summary>Apply all the flags.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlurMaskFilterFlags.HighQuality">
|
|
<summary>Use a smother, higher quality blur algorithm.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlurMaskFilterFlags.IgnoreTransform">
|
|
<summary>The blur layer's radius is not affected by transforms.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlurMaskFilterFlags.None">
|
|
<summary>Do not apply any of the flags.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKBlurStyle">
|
|
<summary>Blur types for the <see cref="M:SkiaSharp.SKMaskFilter.CreateBlur(SkiaSharp.SKBlurStyle,System.Single)" /> method and its overloads.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlurStyle.Inner">
|
|
<summary>Fuzzy inside, nothing outside</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlurStyle.Normal">
|
|
<summary>Fuzzy inside and outside</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlurStyle.Outer">
|
|
<summary>Nothing inside, fuzzy outside</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKBlurStyle.Solid">
|
|
<summary>Solid inside, fuzzy outside</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKCanvas">
|
|
<summary>Encapsulates all of the state about drawing into a device (bitmap or surface).</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
A canvas encapsulates all of the state about drawing into a device (bitmap or
|
|
surface).
|
|
|
|
This includes a reference to the device itself, and a stack of matrix/clip
|
|
values. For any given draw call (e.g. DrawRect), the geometry of the object
|
|
being drawn is transformed by the concatenation of all the matrices in the
|
|
stack. The transformed geometry is clipped by the intersection of all of the
|
|
clips in the stack.
|
|
|
|
While the canvas holds the state of the drawing device, the state (style) of
|
|
the object being drawn is held by the paint, which is provided as a parameter
|
|
to each of the "Draw" methods. The paint holds attributes such as color,
|
|
typeface, the text size, the stroke width, the shader (for example, gradients,
|
|
patterns), etc.
|
|
|
|
The canvas is returned when accessing the
|
|
<xref:SkiaSharp.SKSurface.Canvas?displayProperty=nameWithType> property of a
|
|
surface.
|
|
|
|
### Construction
|
|
|
|
SkiaSharp has multiple backends which receive <xref:SkiaSharp.SKCanvas>
|
|
drawing commands, including:
|
|
|
|
* Raster Surface
|
|
* GPU Surface
|
|
* PDF Document
|
|
* XPS Document _(experimental)_
|
|
* SVG Canvas _(experimental)_
|
|
* Picture
|
|
* Null Canvas _(for testing)_
|
|
|
|
#### Constructing a Raster Surface
|
|
|
|
The raster backend draws to a block of memory. This memory can be managed by
|
|
SkiaSharp or by the client.
|
|
|
|
The recommended way of creating a canvas for the Raster and Ganesh backends is
|
|
to use a <xref:SkiaSharp.SKSurface>, which is an object that manages the
|
|
memory into which the canvas commands are drawn.
|
|
|
|
```csharp
|
|
// define the surface properties
|
|
var info = new SKImageInfo(256, 256);
|
|
|
|
// construct a new surface
|
|
var surface = SKSurface.Create(info);
|
|
|
|
// get the canvas from the surface
|
|
var canvas = surface.Canvas;
|
|
|
|
// draw on the canvas ...
|
|
```
|
|
|
|
Alternatively, we could have specified the memory for the surface explicitly,
|
|
instead of asking SkiaSharp to manage it.
|
|
|
|
```csharp
|
|
// define the surface properties
|
|
var info = new SKImageInfo(256, 256);
|
|
|
|
// allocate memory
|
|
var memory = Marshal.AllocCoTaskMem(info.BytesSize);
|
|
|
|
// construct a surface around the existing memory
|
|
var surface = SKSurface.Create(info, memory, info.RowBytes);
|
|
|
|
// get the canvas from the surface
|
|
var canvas = surface.Canvas;
|
|
|
|
// draw on the canvas ...
|
|
```
|
|
|
|
#### Constructing a GPU Surface
|
|
|
|
GPU surfaces must have a <xref:SkiaSharp.GRContext> object which manages the
|
|
GPU context, and related caches for textures and fonts.
|
|
|
|
<xref:SkiaSharp.GRContext> objects are matched one to one with OpenGL contexts
|
|
or Vulkan devices. That is, all <xref:SkiaSharp.SKSurface> instances that will
|
|
be rendered to using the same OpenGL context or Vulkan device should share a
|
|
<xref:SkiaSharp.GRContext>.
|
|
|
|
SkiaSharp does not create an OpenGL context or a Vulkan device for you. In
|
|
OpenGL mode it also assumes that the correct OpenGL context has been made
|
|
current to the current thread when SkiaSharp calls are made.
|
|
|
|
```csharp
|
|
// an OpenGL context must be created and set as current
|
|
|
|
// define the surface properties
|
|
var info = new SKImageInfo(256, 256);
|
|
|
|
// create the surface
|
|
var context = GRContext.Create(GRBackend.OpenGL);
|
|
var surface = SKSurface.Create(context, false, info);
|
|
|
|
// get the canvas from the surface
|
|
var canvas = surface.Canvas;
|
|
|
|
// draw on the canvas ...
|
|
```
|
|
|
|
#### Constructing a PDF Document
|
|
|
|
The PDF backend uses <xref:SkiaSharp.SKDocument> instead of
|
|
<xref:SkiaSharp.SKSurface>, since a document must include multiple pages.
|
|
|
|
```csharp
|
|
// create the document
|
|
var stream = SKFileWStream.OpenStream("document.pdf");
|
|
var document = SKDocument.CreatePdf(stream);
|
|
|
|
// get the canvas from the page
|
|
var canvas = document.BeginPage(256, 256);
|
|
|
|
// draw on the canvas ...
|
|
|
|
// end the page and document
|
|
document.EndPage();
|
|
document.Close();
|
|
```
|
|
|
|
#### Constructing a XPS Document _(experimental)_
|
|
|
|
The XPS backend uses <xref:SkiaSharp.SKDocument> instead of
|
|
<xref:SkiaSharp.SKSurface>, since a document must include multiple pages.
|
|
|
|
```csharp
|
|
// create the document
|
|
var stream = SKFileWStream.OpenStream("document.xps");
|
|
var document = SKDocument.CreateXps(stream);
|
|
|
|
// get the canvas from the page
|
|
var canvas = document.BeginPage(256, 256);
|
|
|
|
// draw on the canvas ...
|
|
|
|
// end the page and document
|
|
document.EndPage();
|
|
document.Close();
|
|
```
|
|
|
|
#### Constructing a SVG Canvas _(experimental)_
|
|
|
|
The SVG backend uses <xref:SkiaSharp.SKSvgCanvas>.
|
|
|
|
```csharp
|
|
// create the canvas
|
|
var stream = SKFileWStream.OpenStream("image.svg");
|
|
var writer = new SKXmlStreamWriter(stream);
|
|
var canvas = SKSvgCanvas.Create(SKRect.Create(256, 256), writer);
|
|
|
|
// draw on the canvas ...
|
|
```
|
|
|
|
#### Constructing a Picture
|
|
|
|
The XPS backend uses <xref:SkiaSharp.SKPictureRecorder> instead of
|
|
<xref:SkiaSharp.SKSurface>.
|
|
|
|
```csharp
|
|
// create the picture recorder
|
|
var recorder = new SKPictureRecorder();
|
|
|
|
// get the canvas from the page
|
|
var canvas = recorder.BeginRecording(SKRect.Create(256, 256));
|
|
|
|
// draw on the canvas ...
|
|
|
|
// finish recording
|
|
var picture = recorder.EndRecording();
|
|
```
|
|
|
|
#### Constructing a Null Canvas _(for testing)_
|
|
|
|
The null canvas is a canvas that ignores all drawing commands and does
|
|
nothing.
|
|
|
|
```csharp
|
|
// create the dummy canvas
|
|
var canvas = new SKNoDrawCanvas(256, 256);
|
|
|
|
// draw on the canvas ...
|
|
```
|
|
|
|
### Transformations
|
|
|
|
The canvas supports a number of 2D transformations. Unlike other 2D graphic
|
|
systems like CoreGraphics or Cairo, SKCanvas extends the transformations to
|
|
include perspectives.
|
|
|
|
You can use the <xref:SkiaSharp.SKCanvas.Scale%2A>,
|
|
<xref:SkiaSharp.SKCanvas.Skew%2A>, <xref:SkiaSharp.SKCanvas.Translate%2A>,
|
|
<xref:SkiaSharp.SKCanvas.RotateDegrees%2A>,
|
|
<xref:SkiaSharp.SKCanvas.RotateRadians%2A> to perform some of the most common
|
|
2D transformations.
|
|
|
|
For more control you can use the <xref:SkiaSharp.SKCanvas.SetMatrix%2A> to set
|
|
an arbitrary transformation using the <xref:SkiaSharp.SKMatrix> and the
|
|
<xref:SkiaSharp.SKCanvas.Concat%2A> to concatenate an <xref:SkiaSharp.SKMatrix>
|
|
transformation to the current matrix in use.
|
|
|
|
The <xref:SkiaSharp.SKCanvas.ResetMatrix%2A> can be used to reset the state of
|
|
the matrix.
|
|
|
|
### Drawing
|
|
|
|
The drawing operations can take a <xref:SkiaSharp.SKPaint> parameter to affect
|
|
their drawing. You use <xref:SkiaSharp.SKPaint> objects to cache the style and
|
|
color information to draw geometries, texts and bitmaps.
|
|
|
|
### Clipping and State
|
|
|
|
It is possible to save the current transformations by calling the
|
|
<xref:SkiaSharp.SKCanvas.Save%2A> method which preserves the current
|
|
transformation matrix, you can then alter the matrix and restore the previous
|
|
state by using the <xref:SkiaSharp.SKCanvas.Restore%2A> or
|
|
<xref:SkiaSharp.SKCanvas.RestoreToCount%2A> methods.
|
|
|
|
Additionally, it is possible to push a new state with
|
|
<xref:SkiaSharp.SKCanvas.SaveLayer%2A> which will make an offscreen copy of a
|
|
region, and once the drawing is completed, calling the
|
|
<xref:SkiaSharp.SKCanvas.Restore> method which copies the offscreen bitmap
|
|
into this canvas.
|
|
|
|
## Examples
|
|
|
|
```csharp
|
|
var info = new SKImageInfo(640, 480);
|
|
using (var surface = SKSurface.Create(info)) {
|
|
SKCanvas canvas = surface.Canvas;
|
|
|
|
canvas.Clear(SKColors.White);
|
|
|
|
// set up drawing tools
|
|
var paint = new SKPaint {
|
|
IsAntialias = true,
|
|
Color = new SKColor(0x2c, 0x3e, 0x50),
|
|
StrokeCap = SKStrokeCap.Round
|
|
};
|
|
|
|
// create the Xamagon path
|
|
var path = new SKPath();
|
|
path.MoveTo(71.4311121f, 56f);
|
|
path.CubicTo(68.6763107f, 56.0058575f, 65.9796704f, 57.5737917f, 64.5928855f, 59.965729f);
|
|
path.LineTo(43.0238921f, 97.5342563f);
|
|
path.CubicTo(41.6587026f, 99.9325978f, 41.6587026f, 103.067402f, 43.0238921f, 105.465744f);
|
|
path.LineTo(64.5928855f, 143.034271f);
|
|
path.CubicTo(65.9798162f, 145.426228f, 68.6763107f, 146.994582f, 71.4311121f, 147f);
|
|
path.LineTo(114.568946f, 147f);
|
|
path.CubicTo(117.323748f, 146.994143f, 120.020241f, 145.426228f, 121.407172f, 143.034271f);
|
|
path.LineTo(142.976161f, 105.465744f);
|
|
path.CubicTo(144.34135f, 103.067402f, 144.341209f, 99.9325978f, 142.976161f, 97.5342563f);
|
|
path.LineTo(121.407172f, 59.965729f);
|
|
path.CubicTo(120.020241f, 57.5737917f, 117.323748f, 56.0054182f, 114.568946f, 56f);
|
|
path.LineTo(71.4311121f, 56f);
|
|
path.Close();
|
|
|
|
// draw the Xamagon path
|
|
canvas.DrawPath(path, paint);
|
|
}
|
|
```
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKCanvas(SkiaSharp.SKBitmap)">
|
|
<param name="bitmap">The bitmap for the canvas to draw into.</param>
|
|
<summary>Creates a canvas with the specified bitmap to draw into.</summary>
|
|
<remarks>The structure of the bitmap is copied into the canvas.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Clear">
|
|
<summary>Replaces all the pixels in the canvas' current clip with the <see cref="P:SkiaSharp.SKColors.Empty" /> color.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Clear(SkiaSharp.SKColor)">
|
|
<param name="color">The color to use to replace the pixels in the current clipping region.</param>
|
|
<summary>Replaces all the pixels in the canvas' current clip with the specified color.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Clear(SkiaSharp.SKColorF)">
|
|
<param name="color">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.ClipPath(SkiaSharp.SKPath,SkiaSharp.SKClipOperation,System.Boolean)">
|
|
<param name="path">The path to combine with the current clip.</param>
|
|
<param name="operation">The clip operator to apply to the current clip</param>
|
|
<param name="antialias">Whether or not the clip should be antialiased.</param>
|
|
<summary>Modify the current clip with the specified path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.ClipRect(SkiaSharp.SKRect,SkiaSharp.SKClipOperation,System.Boolean)">
|
|
<param name="rect">The rectangle to combine with the current clip.</param>
|
|
<param name="operation">The clip operator to apply to the current clip.</param>
|
|
<param name="antialias">Whether or not the clip should be antialiased.</param>
|
|
<summary>Modify the current clip with the specified rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.ClipRegion(SkiaSharp.SKRegion,SkiaSharp.SKClipOperation)">
|
|
<param name="region">The region to combine with the current clip.</param>
|
|
<param name="operation">The region operator to apply to the current clip.</param>
|
|
<summary>Modify the current clip with the specified region.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.ClipRoundRect(SkiaSharp.SKRoundRect,SkiaSharp.SKClipOperation,System.Boolean)">
|
|
<param name="rect">The rounded rectangle to combine with the current clip.</param>
|
|
<param name="operation">The clip operator to apply to the current clip</param>
|
|
<param name="antialias">Whether or not the clip should be antialiased.</param>
|
|
<summary>Modify the current clip with the specified rounded rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Concat(SkiaSharp.SKMatrix@)">
|
|
<param name="m">Transformation matrix to pre-concatenate.</param>
|
|
<summary>Pre-concatenates the provided transformation matrix with the current transformation matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCanvas.DeviceClipBounds">
|
|
<summary>Gets the bounds of the current clip (in device coordinates).</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Discard">
|
|
<summary>Makes the canvas contents undefined.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Subsequent calls that read the canvas pixels, such as drawing with <xref:SkiaSharp.SKBlendMode>, return undefined
|
|
results. Calling this method does not change clip or matrix and may do nothing, depending on the implementation
|
|
of the underlying <xref:SkiaSharp.SKSurface>.
|
|
|
|
<xref:SkiaSharp.SKCanvas.Discard> allows optimized performance on subsequent draws by removing cached data associated
|
|
with the underlying <xref:SkiaSharp.SKSurface>. It is not necessary to call <xref:SkiaSharp.SKCanvas.Discard> once
|
|
done with <xref:SkiaSharp.SKCanvas>; any cached data is deleted when the owning <xref:SkiaSharp.SKSurface> is deleted.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKCanvas" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKCanvas" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawAnnotation(SkiaSharp.SKRect,System.String,SkiaSharp.SKData)">
|
|
<param name="rect">The bounds of the annotation.</param>
|
|
<param name="key">The name of the annotation.</param>
|
|
<param name="value">The blob of data to attach to the annotation.</param>
|
|
<summary>Send an key/value pair "annotation" to the canvas.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The caller still retains its ownership of the data (if any).
|
|
|
|
Note: on may canvas types, this information is ignored, but some
|
|
canvases (e.g. recording a picture or drawing to a PDF document) will pass on
|
|
this information.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawArc(SkiaSharp.SKRect,System.Single,System.Single,System.Boolean,SkiaSharp.SKPaint)">
|
|
<param name="oval">To be added.</param>
|
|
<param name="startAngle">To be added.</param>
|
|
<param name="sweepAngle">To be added.</param>
|
|
<param name="useCenter">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawAtlas(SkiaSharp.SKImage,SkiaSharp.SKRect[],SkiaSharp.SKRotationScaleMatrix[],SkiaSharp.SKPaint)">
|
|
<param name="atlas">To be added.</param>
|
|
<param name="sprites">To be added.</param>
|
|
<param name="transforms">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawAtlas(SkiaSharp.SKImage,SkiaSharp.SKRect[],SkiaSharp.SKRotationScaleMatrix[],SkiaSharp.SKColor[],SkiaSharp.SKBlendMode,SkiaSharp.SKPaint)">
|
|
<param name="atlas">To be added.</param>
|
|
<param name="sprites">To be added.</param>
|
|
<param name="transforms">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawAtlas(SkiaSharp.SKImage,SkiaSharp.SKRect[],SkiaSharp.SKRotationScaleMatrix[],SkiaSharp.SKColor[],SkiaSharp.SKBlendMode,SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="atlas">To be added.</param>
|
|
<param name="sprites">To be added.</param>
|
|
<param name="transforms">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<param name="cullRect">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawBitmap(SkiaSharp.SKBitmap,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="bitmap">The bitmap to draw.</param>
|
|
<param name="p">The destination coordinates for the bitmap.</param>
|
|
<param name="paint">The paint to use when drawing the bitmap.</param>
|
|
<summary>Draws a bitmap on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawBitmap(SkiaSharp.SKBitmap,SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="bitmap">The bitmap to draw.</param>
|
|
<param name="dest">The region to draw the bitmap into.</param>
|
|
<param name="paint">The paint to use when drawing the bitmap.</param>
|
|
<summary>Draws a bitmap on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawBitmap(SkiaSharp.SKBitmap,SkiaSharp.SKRect,SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="bitmap">The bitmap to draw.</param>
|
|
<param name="source">The source region to copy.</param>
|
|
<param name="dest">The region to draw the bitmap into.</param>
|
|
<param name="paint">The paint to use when drawing the bitmap.</param>
|
|
<summary>Draws a bitmap on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawBitmap(SkiaSharp.SKBitmap,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="bitmap">The bitmap to draw.</param>
|
|
<param name="x">The destination x-coordinate for the bitmap.</param>
|
|
<param name="y">The destination y-coordinate for the bitmap.</param>
|
|
<param name="paint">The paint to use when drawing the bitmap.</param>
|
|
<summary>Draws a bitmap on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawBitmapLattice(SkiaSharp.SKBitmap,SkiaSharp.SKLattice,SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="bitmap">The bitmap to draw.</param>
|
|
<param name="lattice">The lattice that describes the areas of the bitmap to stretch or shrink.</param>
|
|
<param name="dst">The region to draw the bitmap into.</param>
|
|
<param name="paint">The paint to use when drawing the bitmap.</param>
|
|
<summary>Draws the bitmap, stretched or shrunk differentially to fit into the destination rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawBitmapLattice(SkiaSharp.SKBitmap,System.Int32[],System.Int32[],SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="bitmap">The bitmap to draw.</param>
|
|
<param name="xDivs">The x-coordinates that divide the bitmap vertically, describing the areas to stretch or shrink.</param>
|
|
<param name="yDivs">The y-coordinates that divide the bitmap horizontally, describing the areas to stretch or shrink.</param>
|
|
<param name="dst">The region to draw the bitmap into.</param>
|
|
<param name="paint">The paint to use when drawing the bitmap.</param>
|
|
<summary>Draws the bitmap, stretched or shrunk differentially to fit into the destination rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawBitmapNinePatch(SkiaSharp.SKBitmap,SkiaSharp.SKRectI,SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="bitmap">The bitmap to draw.</param>
|
|
<param name="center">The center region within the bitmap to logically divide the bitmap into 9 sections (3x3).</param>
|
|
<param name="dst">The region to draw the bitmap into.</param>
|
|
<param name="paint">The paint to use when drawing the bitmap.</param>
|
|
<summary>Draws the bitmap, stretched or shrunk differentially to fit into the destination rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawCircle(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="c">The center coordinates.</param>
|
|
<param name="radius">The radius for the circle.</param>
|
|
<param name="paint">The paint to use when drawing the circle.</param>
|
|
<summary>Draws a circle on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawCircle(System.Single,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="cx">The center x-coordinate.</param>
|
|
<param name="cy">The center y-coordinate.</param>
|
|
<param name="radius">The radius for the circle.</param>
|
|
<param name="paint">The paint to use when drawing the circle.</param>
|
|
<summary>Draws a circle on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawColor(SkiaSharp.SKColor,SkiaSharp.SKBlendMode)">
|
|
<param name="color">The color to use to paint the clipping region.</param>
|
|
<param name="mode">The blend mode for the color.</param>
|
|
<summary>Fills the current clipping area with the specified color using the specified color and blend mode.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawColor(SkiaSharp.SKColorF,SkiaSharp.SKBlendMode)">
|
|
<param name="color">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawDrawable(SkiaSharp.SKDrawable,SkiaSharp.SKMatrix@)">
|
|
<param name="drawable">The drawable to draw.</param>
|
|
<param name="matrix">The matrix to apply while painting.</param>
|
|
<summary>Draws a drawable on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawDrawable(SkiaSharp.SKDrawable,SkiaSharp.SKPoint)">
|
|
<param name="drawable">The drawable to draw.</param>
|
|
<param name="p">The destination coordinates for the drawable.</param>
|
|
<summary>Draws a drawable on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawDrawable(SkiaSharp.SKDrawable,System.Single,System.Single)">
|
|
<param name="drawable">The drawable to draw.</param>
|
|
<param name="x">The destination x-coordinate for the drawable.</param>
|
|
<param name="y">The destination y-coordinate for the drawable.</param>
|
|
<summary>Draws a drawable on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawImage(SkiaSharp.SKImage,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="image">The image to draw.</param>
|
|
<param name="p">The destination coordinates for the image.</param>
|
|
<param name="paint">The paint to use when drawing the image, or <see langword="null" />.</param>
|
|
<summary>Draws an image on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawImage(SkiaSharp.SKImage,SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="image">The image to draw.</param>
|
|
<param name="dest">The region to draw the image into.</param>
|
|
<param name="paint">The paint to use when drawing the image, or <see langword="null" />.</param>
|
|
<summary>Draws an image on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawImage(SkiaSharp.SKImage,SkiaSharp.SKRect,SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="image">The image to draw.</param>
|
|
<param name="source">The source region to copy.</param>
|
|
<param name="dest">The region to draw the image into.</param>
|
|
<param name="paint">The paint to use when drawing the image, or <see langword="null" />.</param>
|
|
<summary>Draws an image on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawImage(SkiaSharp.SKImage,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="image">The image to draw.</param>
|
|
<param name="x">The destination x-coordinate for the image.</param>
|
|
<param name="y">The destination y-coordinate for the image.</param>
|
|
<param name="paint">The paint to use when drawing the image, or <see langword="null" />.</param>
|
|
<summary>Draws an image on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawImageLattice(SkiaSharp.SKImage,SkiaSharp.SKLattice,SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="image">The image to draw.</param>
|
|
<param name="lattice">The lattice that describes the areas of the image to stretch or shrink.</param>
|
|
<param name="dst">The region to draw the image into.</param>
|
|
<param name="paint">The paint to use when drawing the image, or <see langword="null" />.</param>
|
|
<summary>Draws the image, stretched or shrunk differentially to fit into the destination rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawImageLattice(SkiaSharp.SKImage,System.Int32[],System.Int32[],SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="image">The image to draw.</param>
|
|
<param name="xDivs">The x-coordinates that divide the image vertically, describing the areas to stretch or shrink.</param>
|
|
<param name="yDivs">The Y-coordinates that divide the image horizontally, describing the areas to stretch or shrink.</param>
|
|
<param name="dst">The region to draw the image into.</param>
|
|
<param name="paint">The paint to use when drawing the image, or <see langword="null" />.</param>
|
|
<summary>Draws the image, stretched or shrunk differentially to fit into the destination rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawImageNinePatch(SkiaSharp.SKImage,SkiaSharp.SKRectI,SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="image">The image to draw.</param>
|
|
<param name="center">The center region within the image to logically divide the image into 9 sections (3x3).</param>
|
|
<param name="dst">The region to draw the image into.</param>
|
|
<param name="paint">The paint to use when drawing the image, or <see langword="null" />.</param>
|
|
<summary>Draws the image, stretched or shrunk differentially to fit into the destination rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawLine(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="p0">The first point coordinates.</param>
|
|
<param name="p1">The second point coordinates.</param>
|
|
<param name="paint">The paint to use when drawing the line.</param>
|
|
<summary>Draws a line on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawLine(System.Single,System.Single,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="x0">The first point x-coordinate.</param>
|
|
<param name="y0">The first point y-coordinate.</param>
|
|
<param name="x1">The second point x-coordinate.</param>
|
|
<param name="y1">The second point y-coordinate.</param>
|
|
<param name="paint">The paint to use when drawing the line.</param>
|
|
<summary>Draws a line on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawLinkDestinationAnnotation(SkiaSharp.SKRect,SkiaSharp.SKData)">
|
|
<param name="rect">The bounds of the annotation.</param>
|
|
<param name="value">The data that specifies the name of the link's destination.</param>
|
|
<summary>Annotates the canvas by making the specified rectangle link to a named destination (see <see cref="M:SkiaSharp.SKCanvas.DrawNamedDestinationAnnotation(SkiaSharp.SKPoint,SkiaSharp.SKData)" />).</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The caller is responsible for managing its ownership of the data.
|
|
|
|
If the backend of this canvas does not support annotations, this call is
|
|
safely ignored.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawLinkDestinationAnnotation(SkiaSharp.SKRect,System.String)">
|
|
<param name="rect">The bounds of the annotation.</param>
|
|
<param name="value">The name of the link's destination.</param>
|
|
<summary>Annotates the canvas by making the specified rectangle link to a named destination (see <see cref="M:SkiaSharp.SKCanvas.DrawNamedDestinationAnnotation(SkiaSharp.SKPoint,System.String)" />).</summary>
|
|
<returns>Returns the actual data object that was attached to the canvas.</returns>
|
|
<remarks>If the backend of this canvas does not support annotations, this call is safely ignored.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawNamedDestinationAnnotation(SkiaSharp.SKPoint,SkiaSharp.SKData)">
|
|
<param name="point">The location of the destination.</param>
|
|
<param name="value">The data that specifies the name of the destination.</param>
|
|
<summary>Annotates the canvas by associating a name with the specified point (see <see cref="M:SkiaSharp.SKCanvas.DrawLinkDestinationAnnotation(SkiaSharp.SKRect,SkiaSharp.SKData)" />).</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The caller is responsible for managing its ownership of the data.
|
|
|
|
If the backend of this canvas does not support annotations, this call is
|
|
safely ignored.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawNamedDestinationAnnotation(SkiaSharp.SKPoint,System.String)">
|
|
<param name="point">The location of the destination.</param>
|
|
<param name="value">The name of the destination.</param>
|
|
<summary>Annotates the canvas by associating a name with the specified point (see <see cref="M:SkiaSharp.SKCanvas.DrawLinkDestinationAnnotation(SkiaSharp.SKRect,System.String)" />).</summary>
|
|
<returns>Returns the actual data object that was attached to the canvas.</returns>
|
|
<remarks>If the backend of this canvas does not support annotations, this call is safely ignored.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawOval(SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="rect">The bounding box for the oval.</param>
|
|
<param name="paint">The paint to use when drawing the oval.</param>
|
|
<summary>Draws an oval on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawOval(SkiaSharp.SKPoint,SkiaSharp.SKSize,SkiaSharp.SKPaint)">
|
|
<param name="c">The center coordinates.</param>
|
|
<param name="r">The radius for the oval.</param>
|
|
<param name="paint">The paint to use when drawing the oval.</param>
|
|
<summary>Draws an oval on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawOval(System.Single,System.Single,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="cx">The center x-coordinate.</param>
|
|
<param name="cy">The center y-coordinate.</param>
|
|
<param name="rx">The vertical radius for the oval.</param>
|
|
<param name="ry">The horizontal radius for the oval.</param>
|
|
<param name="paint">The paint to use when drawing the oval.</param>
|
|
<summary>Draws an oval on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPaint(SkiaSharp.SKPaint)">
|
|
<param name="paint">The paint used to fill the current clipping path.</param>
|
|
<summary>Fills the current clipping path with the specified paint.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPatch(SkiaSharp.SKPoint[],SkiaSharp.SKColor[],SkiaSharp.SKPoint[],SkiaSharp.SKPaint)">
|
|
<param name="cubics">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="texCoords">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPatch(SkiaSharp.SKPoint[],SkiaSharp.SKColor[],SkiaSharp.SKPoint[],SkiaSharp.SKBlendMode,SkiaSharp.SKPaint)">
|
|
<param name="cubics">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="texCoords">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPath(SkiaSharp.SKPath,SkiaSharp.SKPaint)">
|
|
<param name="path">The path to draw.</param>
|
|
<param name="paint">The paint to use when drawing the path.</param>
|
|
<summary>Draws a path in the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPicture(SkiaSharp.SKPicture,SkiaSharp.SKPaint)">
|
|
<param name="picture">The picture to draw.</param>
|
|
<param name="paint">The paint to use when drawing the picture, or <see langword="null" />.</param>
|
|
<summary>Draws a picture on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPicture(SkiaSharp.SKPicture,SkiaSharp.SKMatrix@,SkiaSharp.SKPaint)">
|
|
<param name="picture">The picture to draw.</param>
|
|
<param name="matrix">The matrix to apply while painting.</param>
|
|
<param name="paint">The paint to use when drawing the picture, or <see langword="null" />.</param>
|
|
<summary>Draws a picture on the canvas.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This is equivalent to calling <xref:SkiaSharp.SKCanvas.Save>, followed by
|
|
<xref:SkiaSharp.SKCanvas.Concat(SkiaSharp.SKMatrix@)> with the specified `matrix`,
|
|
<xref:SkiaSharp.SKCanvas.DrawPicture(SkiaSharp.SKPicture,SkiaSharp.SKPaint)>
|
|
and then <xref:SkiaSharp.SKCanvas.Restore>.
|
|
|
|
If paint is non-null, the picture is drawn into a temporary buffer, and then
|
|
the paint's alpha, color filter, image filter, blend mode are applied to that
|
|
buffer as it is drawn to the canvas.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPicture(SkiaSharp.SKPicture,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="picture">The picture to draw.</param>
|
|
<param name="p">The destination coordinates for the picture.</param>
|
|
<param name="paint">The paint to use when drawing the picture, or <see langword="null" />.</param>
|
|
<summary>Draws a picture on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPicture(SkiaSharp.SKPicture,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="picture">The picture to draw.</param>
|
|
<param name="x">The destination x-coordinate for the picture.</param>
|
|
<param name="y">The destination y-coordinate for the picture.</param>
|
|
<param name="paint">The paint to use when drawing the picture, or <see langword="null" />.</param>
|
|
<summary>Draws a picture on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPoint(SkiaSharp.SKPoint,SkiaSharp.SKColor)">
|
|
<param name="p">The coordinates for the point to draw.</param>
|
|
<param name="color">The color to use.</param>
|
|
<summary>Draws a point in the canvas with the specified color.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPoint(SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="p">The coordinates for the point to draw.</param>
|
|
<param name="paint">The paint to use when drawing the point.</param>
|
|
<summary>Draws a point in the canvas with the specified color.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPoint(System.Single,System.Single,SkiaSharp.SKColor)">
|
|
<param name="x">The x-coordinate for the point to draw.</param>
|
|
<param name="y">The y-coordinate for the point to draw.</param>
|
|
<param name="color">The color to use.</param>
|
|
<summary>Draws a point in the canvas with the specified color.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPoint(System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="x">The x-coordinate for the point to draw.</param>
|
|
<param name="y">The y-coordinate for the point to draw.</param>
|
|
<param name="paint">The paint to use when drawing the point.</param>
|
|
<summary>Draws a point in the canvas with the specified color.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPoints(SkiaSharp.SKPointMode,SkiaSharp.SKPoint[],SkiaSharp.SKPaint)">
|
|
<param name="mode">Determines how the points array will be interpreted: as points, as coordinates to draw lines, or as coordinates of a polygon.</param>
|
|
<param name="points">The array of points to draw.</param>
|
|
<param name="paint">The paint to use when drawing the points.</param>
|
|
<summary>Draws an array of points, lines or a polygon in the canvas, one at a time.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
For <xref:SkiaSharp.SKPointMode.Points>, each point is drawn centered at its
|
|
coordinate, and its size is specified by the paint's stroke-width. It draws as
|
|
a square, unless the paint's <xref:SkiaSharp.SKPaint.StrokeCap> is
|
|
<xref:SkiaSharp.SKStrokeCap.Round>, in which the points are drawn as circles.
|
|
|
|
For <xref:SkiaSharp.SKPointMode.Lines>, each pair of points is drawn as a line
|
|
segment, respecting the paint's settings for cap, join and width.
|
|
|
|
For <xref:SkiaSharp.SKPointMode.Polygon>, the entire array is drawn as a
|
|
series of connected line segments.
|
|
|
|
Note that, while similar, the line and polygon modes draw slightly differently
|
|
than the equivalent path built with a series of move to, line to calls, in
|
|
that the path will draw all of its contours at once, with no interactions if
|
|
contours intersect each other (think <xref:SkiaSharp.SKBlendMode.Xor>).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPositionedText(System.Byte[],SkiaSharp.SKPoint[],SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="points">The positions for each glyph in the <paramref name="text" /> string.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws glyphs of the text at specified locations on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPositionedText(System.String,SkiaSharp.SKPoint[],SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="points">The positions for each glyph in the <paramref name="text" /> string.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws glyphs of the text at specified locations on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawPositionedText(System.IntPtr,System.Int32,SkiaSharp.SKPoint[],SkiaSharp.SKPaint)">
|
|
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="points">The positions for each glyph in the <paramref name="buffer." /></param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text from a UTF-8 buffer at specified locations on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawRect(SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="rect">The rectangle to draw.</param>
|
|
<param name="paint">The paint to use when drawing the rectangle.</param>
|
|
<summary>Draws a rectangle in the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawRect(System.Single,System.Single,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="x">The x-coordinate.</param>
|
|
<param name="y">The y-coordinate.</param>
|
|
<param name="w">The rectangle width.</param>
|
|
<param name="h">The rectangle height.</param>
|
|
<param name="paint">The paint to use when drawing the rectangle.</param>
|
|
<summary>Draws a rectangle in the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawRegion(SkiaSharp.SKRegion,SkiaSharp.SKPaint)">
|
|
<param name="region">The region to be drawn.</param>
|
|
<param name="paint">The paint to use when drawing the region.</param>
|
|
<summary>Draws the outline of the specified region using the specified paint.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawRoundRect(SkiaSharp.SKRoundRect,SkiaSharp.SKPaint)">
|
|
<param name="rect">The rounded rectangle to draw.</param>
|
|
<param name="paint">The paint to use when drawing the rectangle.</param>
|
|
<summary>Draws a rounded rectangle in the canvas.</summary>
|
|
<remarks>The paint to use when drawing the rounded rectangle.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawRoundRect(SkiaSharp.SKRect,SkiaSharp.SKSize,SkiaSharp.SKPaint)">
|
|
<param name="rect">The rectangle to draw.</param>
|
|
<param name="r">The radius of the oval used to round the corners.</param>
|
|
<param name="paint">The paint to use when drawing the rectangle.</param>
|
|
<summary>Draws a rounded rectangle in the canvas.</summary>
|
|
<remarks>The paint to use when drawing the rectangle.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawRoundRect(SkiaSharp.SKRect,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="rect">The rectangle to draw.</param>
|
|
<param name="rx">The x-radius of the oval used to round the corners.</param>
|
|
<param name="ry">The y-radius of the oval used to round the corners.</param>
|
|
<param name="paint">The paint to use when drawing the rectangle.</param>
|
|
<summary>Draws a rounded rectangle in the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawRoundRect(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="x">The x-coordinate of the rectangle.</param>
|
|
<param name="y">The y-coordinate of the rectangle.</param>
|
|
<param name="w">The rectangle width.</param>
|
|
<param name="h">The rectangle height.</param>
|
|
<param name="rx">The x-radius of the oval used to round the corners.</param>
|
|
<param name="ry">The y-radius of the oval used to round the corners.</param>
|
|
<param name="paint">The paint to use when drawing the rectangle.</param>
|
|
<summary>Draws a rounded rectangle in the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawRoundRectDifference(SkiaSharp.SKRoundRect,SkiaSharp.SKRoundRect,SkiaSharp.SKPaint)">
|
|
<param name="outer">To be added.</param>
|
|
<param name="inner">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawSurface(SkiaSharp.SKSurface,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="surface">The surface to draw.</param>
|
|
<param name="p">The destination coordinates for the surface.</param>
|
|
<param name="paint">The paint to use when drawing the surface, or <see langword="null" />.</param>
|
|
<summary>Draws a surface on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawSurface(SkiaSharp.SKSurface,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="surface">The surface to draw.</param>
|
|
<param name="x">The destination x-coordinate for the surface.</param>
|
|
<param name="y">The destination y-coordinate for the surface.</param>
|
|
<param name="paint">The paint to use when drawing the surface, or <see langword="null" />.</param>
|
|
<summary>Draws a surface on the canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawText(System.Byte[],SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="p">The coordinates of the origin of the text being drawn.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text on the canvas at the specified coordinates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawText(System.String,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="p">The coordinates of the origin of the text being drawn.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text on the canvas at the specified coordinates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawText(SkiaSharp.SKTextBlob,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="text">The text blob to draw.</param>
|
|
<param name="x">The x-coordinate of the origin of the text being drawn.</param>
|
|
<param name="y">The y-coordinate of the origin of the text being drawn.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws a text blob on the canvas at the specified coordinates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawText(System.Byte[],System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="x">The x-coordinate of the origin of the text being drawn.</param>
|
|
<param name="y">The y-coordinate of the origin of the text being drawn.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text on the canvas at the specified coordinates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawText(System.IntPtr,System.Int32,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="p">The coordinates of the origin of the text being drawn.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text encoded in a UTF-8 buffer on the canvas at the specified coordinates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawText(System.String,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="x">The x-coordinate of the origin of the text being drawn.</param>
|
|
<param name="y">The y-coordinate of the origin of the text being drawn.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text on the canvas at the specified coordinates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawText(System.IntPtr,System.Int32,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="x">The x-coordinate of the origin of the text being drawn.</param>
|
|
<param name="y">The y-coordinate of the origin of the text being drawn.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text encoded in a UTF-8 buffer on the canvas at the specified coordinates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawText(System.String,System.Single,System.Single,SkiaSharp.SKFont,SkiaSharp.SKPaint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawTextOnPath(System.Byte[],SkiaSharp.SKPath,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="path">The path the text should follow for its baseline.</param>
|
|
<param name="offset">The offset to the path to add to the text's starting position.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text on the canvas following a path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawTextOnPath(System.String,SkiaSharp.SKPath,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="path">The path the text should follow for its baseline.</param>
|
|
<param name="offset">The offset to the path to add to the text's starting position.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text on the canvas following a path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawTextOnPath(System.Byte[],SkiaSharp.SKPath,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="path">The path the text should follow for its baseline.</param>
|
|
<param name="hOffset">The distance along the path to add to the text's starting position.</param>
|
|
<param name="vOffset">The distance above (-) or below (+) the path to position the text.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text on the canvas following a path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawTextOnPath(System.IntPtr,System.Int32,SkiaSharp.SKPath,SkiaSharp.SKPoint,SkiaSharp.SKPaint)">
|
|
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="path">The path the text should follow for its baseline.</param>
|
|
<param name="offset">The offset to the path to add to the text's starting position.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text on the canvas following a path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawTextOnPath(System.String,SkiaSharp.SKPath,SkiaSharp.SKPoint,System.Boolean,SkiaSharp.SKPaint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="path">To be added.</param>
|
|
<param name="offset">To be added.</param>
|
|
<param name="warpGlyphs">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawTextOnPath(System.String,SkiaSharp.SKPath,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="text">The text to draw.</param>
|
|
<param name="path">The path the text should follow for its baseline.</param>
|
|
<param name="hOffset">The distance along the path to add to the text's starting position.</param>
|
|
<param name="vOffset">The distance above (-) or below (+) the path to position the text.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text on the canvas following a path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawTextOnPath(System.IntPtr,System.Int32,SkiaSharp.SKPath,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="buffer">The pointer to a region holding UTF-8 encoded text to draw.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="path">The path the text should follow for its baseline.</param>
|
|
<param name="hOffset">The distance along the path to add to the text's starting position.</param>
|
|
<param name="vOffset">The distance above (-) or below (+) the path to position the text.</param>
|
|
<param name="paint">The paint to use when drawing the text.</param>
|
|
<summary>Draws text encoded in a UTF-8 buffer on the canvas following a path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawTextOnPath(System.String,SkiaSharp.SKPath,SkiaSharp.SKPoint,System.Boolean,SkiaSharp.SKFont,SkiaSharp.SKPaint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="path">To be added.</param>
|
|
<param name="offset">To be added.</param>
|
|
<param name="warpGlyphs">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawUrlAnnotation(SkiaSharp.SKRect,SkiaSharp.SKData)">
|
|
<param name="rect">The bounds of the annotation.</param>
|
|
<param name="value">The data that specifies the URL.</param>
|
|
<summary>Annotates the canvas by associating the specified URL with the specified rectangle (in local coordinates).</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The caller is responsible for managing its ownership of the data.
|
|
|
|
If the backend of this canvas does not support annotations, this call is
|
|
safely ignored.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawUrlAnnotation(SkiaSharp.SKRect,System.String)">
|
|
<param name="rect">The bounds of the annotation.</param>
|
|
<param name="value">The URL.</param>
|
|
<summary>Annotates the canvas by associating the specified URL with the specified rectangle (in local coordinates).</summary>
|
|
<returns>Returns the actual data object that was attached to the canvas.</returns>
|
|
<remarks>If the backend of this canvas does not support annotations, this call is safely ignored.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawVertices(SkiaSharp.SKVertices,SkiaSharp.SKBlendMode,SkiaSharp.SKPaint)">
|
|
<param name="vertices">The mesh to draw.</param>
|
|
<param name="mode">The blend mode to use to combine the colors with the texture, before being drawn using the paint. Used if both texture coordinates and colors are present.</param>
|
|
<param name="paint">The shader/texture.</param>
|
|
<summary>Draws a set of vertices.</summary>
|
|
<remarks>If both textures and vertex-colors are <see langword="null" />, it strokes hairlines with the paint's color. This behavior is a useful debugging mode to visualize the mesh.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawVertices(SkiaSharp.SKVertexMode,SkiaSharp.SKPoint[],SkiaSharp.SKColor[],SkiaSharp.SKPaint)">
|
|
<param name="vmode">How to interpret the array of vertices.</param>
|
|
<param name="vertices">The array of vertices for the mesh.</param>
|
|
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
|
<param name="paint">The shader/texture.</param>
|
|
<summary>Draws an array of vertices, interpreted as triangles (based on mode).</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawVertices(SkiaSharp.SKVertexMode,SkiaSharp.SKPoint[],SkiaSharp.SKPoint[],SkiaSharp.SKColor[],SkiaSharp.SKPaint)">
|
|
<param name="vmode">How to interpret the array of vertices.</param>
|
|
<param name="vertices">The array of vertices for the mesh.</param>
|
|
<param name="texs">The coordinates in texture space (not UV space) for each vertex. May be <see langword="null" />.</param>
|
|
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
|
<param name="paint">The shader/texture.</param>
|
|
<summary>Draws an array of vertices, interpreted as triangles (based on mode).</summary>
|
|
<remarks>If both textures and vertex-colors are <see langword="null" />, it strokes hairlines with the paint's color. This behavior is a useful debugging mode to visualize the mesh.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawVertices(SkiaSharp.SKVertexMode,SkiaSharp.SKPoint[],SkiaSharp.SKPoint[],SkiaSharp.SKColor[],System.UInt16[],SkiaSharp.SKPaint)">
|
|
<param name="vmode">How to interpret the array of vertices.</param>
|
|
<param name="vertices">The array of vertices for the mesh.</param>
|
|
<param name="texs">The coordinates in texture space (not UV space) for each vertex. May be <see langword="null" />.</param>
|
|
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
|
<param name="indices">The array of indices to reference into the vertex (texture coordinates, colors) array.</param>
|
|
<param name="paint">The shader/texture.</param>
|
|
<summary>Draws an array of vertices, interpreted as triangles (based on mode).</summary>
|
|
<remarks>If both textures and vertex-colors are <see langword="null" />, it strokes hairlines with the paint's color. This behavior is a useful debugging mode to visualize the mesh.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.DrawVertices(SkiaSharp.SKVertexMode,SkiaSharp.SKPoint[],SkiaSharp.SKPoint[],SkiaSharp.SKColor[],SkiaSharp.SKBlendMode,System.UInt16[],SkiaSharp.SKPaint)">
|
|
<param name="vmode">How to interpret the array of vertices.</param>
|
|
<param name="vertices">The array of vertices for the mesh.</param>
|
|
<param name="texs">The coordinates in texture space (not UV space) for each vertex. May be <see langword="null" />.</param>
|
|
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
|
<param name="mode">The blend mode to use to combine the colors with the texture, before being drawn using the paint. Used if both texture coordinates and colors are present.</param>
|
|
<param name="indices">The array of indices to reference into the vertex (texture coordinates, colors) array.</param>
|
|
<param name="paint">The shader/texture.</param>
|
|
<summary>Draws an array of vertices, interpreted as triangles (based on mode).</summary>
|
|
<remarks>If both textures and vertex-colors are <see langword="null" />, it strokes hairlines with the paint's color. This behavior is a useful debugging mode to visualize the mesh.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Flush">
|
|
<summary>Triggers the immediate execution of all pending draw operations.</summary>
|
|
<remarks>For the GPU backend this will resolve all rendering to the GPU surface backing the surface that owns this canvas.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.GetDeviceClipBounds(SkiaSharp.SKRectI@)">
|
|
<param name="bounds">The resulting clip bounds.</param>
|
|
<summary>Returns the bounds of the current clip (in device coordinates).</summary>
|
|
<returns>Returns true if the clip bounds are non-empty, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.GetLocalClipBounds(SkiaSharp.SKRect@)">
|
|
<param name="bounds">The resulting clip bounds.</param>
|
|
<summary>Returns the bounds of the current clip (in local coordinates).</summary>
|
|
<returns>Returns true if the clip bounds are non-empty, otherwise false.</returns>
|
|
<remarks>This can be useful in that it tells you that drawing outside of these bounds will be clipped out.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCanvas.IsClipEmpty">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCanvas.IsClipRect">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCanvas.LocalClipBounds">
|
|
<summary>Gets the bounds of the current clip (in local coordinates).</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.QuickReject(SkiaSharp.SKPath)">
|
|
<param name="path">The path to compare with the current clip.</param>
|
|
<summary>Checks to see if the specified path, after being transformed by the current matrix, would lie completely outside of the current clip.</summary>
|
|
<returns>Returns true if the path (transformed by the canvas' matrix) does not intersect with the canvas' clip.</returns>
|
|
<remarks>Call this to check if an area you intend to draw into is clipped out (and therefore you can skip making the draw calls).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.QuickReject(SkiaSharp.SKRect)">
|
|
<param name="rect">The rectangle to compare with the current clip.</param>
|
|
<summary>Checks to see if the specified rectangle, after being transformed by the current matrix, would lie completely outside of the current clip.</summary>
|
|
<returns>Returns true if the rectangle (transformed by the canvas' matrix) does not intersect with the canvas' clip.</returns>
|
|
<remarks>Call this to check if an area you intend to draw into is clipped out (and therefore you can skip making the draw calls).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.ResetMatrix">
|
|
<summary>Sets the current matrix to identity.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Restore">
|
|
<summary>Restore the canvas state.</summary>
|
|
<remarks>This call balances a previous call to <see cref="M:SkiaSharp.SKCanvas.Save" />, and is used to remove all modifications to the matrix, clip and draw filter state since the last save call. It is an error to restore more times than was previously saved.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.RestoreToCount(System.Int32)">
|
|
<param name="count">The number of <see cref="M:SkiaSharp.SKCanvas.Save" /> levels to restore from, or -1 to restore all the way back to the initial value.</param>
|
|
<summary>Efficiently restores the state to a specific level.</summary>
|
|
<remarks>Efficient way to pop any calls to <see cref="M:SkiaSharp.SKCanvas.Save" /> that happened after the save count reached <paramref name="count" />. It is an error for <paramref name="count" /> to be greater than <see cref="P:SkiaSharp.SKCanvas.SaveCount" />. To pop all the way back to the initial matrix/clip context set count to -1.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.RotateDegrees(System.Single)">
|
|
<param name="degrees">The number of degrees to rotate.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified rotation.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.RotateDegrees(System.Single,System.Single,System.Single)">
|
|
<param name="degrees">The number of degrees to rotate.</param>
|
|
<param name="px">The x-coordinate of the point to rotate about.</param>
|
|
<param name="py">The y-coordinate of the point to rotate about.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified rotation, around the specified point.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.RotateRadians(System.Single)">
|
|
<param name="radians">The number of radians to rotate.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified rotation.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.RotateRadians(System.Single,System.Single,System.Single)">
|
|
<param name="radians">The number of radians to rotate.</param>
|
|
<param name="px">The x-coordinate of the point to rotate about.</param>
|
|
<param name="py">The y-coordinate of the point to rotate about.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified rotation, around the specified point.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Save">
|
|
<summary>Saves the canvas state.</summary>
|
|
<returns>The value to pass to <see cref="M:SkiaSharp.SKCanvas.RestoreToCount(System.Int32)" /> to balance this save.</returns>
|
|
<remarks>This call saves the current matrix, clip, and draw filter, and pushes a copy onto a private stack. Subsequent calls to translate, scale, rotate, skew, concatenate or clipping path or drawing filter all operate on this copy. When the balancing call to <see cref="M:SkiaSharp.SKCanvas.Restore" /> is made, the previous matrix, clipping, and drawing filters are restored.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCanvas.SaveCount">
|
|
<summary>Gets the number of matrix/clip states on the canvas' private stack.</summary>
|
|
<value />
|
|
<remarks>This will equal the number of <see cref="M:SkiaSharp.SKCanvas.Save" /> calls minus <see cref="M:SkiaSharp.SKCanvas.Restore" /> calls + 1. The save count on a new canvas is 1.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.SaveLayer">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.SaveLayer(SkiaSharp.SKPaint)">
|
|
<param name="paint">This is copied, and is applied to the offscreen when <see cref="M:SkiaSharp.SKCanvas.Restore" /> is called.</param>
|
|
<summary>Saves the canvas state and allocates an offscreen bitmap.</summary>
|
|
<returns>The value to pass to <see cref="M:SkiaSharp.SKCanvas.RestoreToCount(System.Int32)" /> to balance this save.</returns>
|
|
<remarks>This behaves the same as <see cref="M:SkiaSharp.SKCanvas.Save" /> but in addition it allocates an offscreen bitmap. All drawing calls are directed there, and only when the balancing call to <see cref="M:SkiaSharp.SKCanvas.Restore" /> is made is that offscreen transfered to the canvas (or the previous layer).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.SaveLayer(SkiaSharp.SKRect,SkiaSharp.SKPaint)">
|
|
<param name="limit">This clipping rectangle hint to limit the size of the offscreen bitmap.</param>
|
|
<param name="paint">This is copied, and is applied to the offscreen when <see cref="M:SkiaSharp.SKCanvas.Restore" /> is called.</param>
|
|
<summary>Saves the canvas state and allocates an offscreen bitmap.</summary>
|
|
<returns>The value to pass to <see cref="M:SkiaSharp.SKCanvas.RestoreToCount(System.Int32)" /> to balance this save.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This behaves the same as <xref:SkiaSharp.SKCanvas.Save> but in addition it
|
|
allocates an offscreen bitmap. All drawing calls are directed there, and only
|
|
when the balancing call to <xref:SkiaSharp.SKCanvas.Restore> is made is that
|
|
offscreen transfered to the canvas (or the previous layer).
|
|
|
|
The limit rectangle, is used as a hint to limit the size of the offscreen
|
|
bitmap, and thus drawing may be clipped to it, though that clipping is not
|
|
guaranteed to happen. If exact clipping is desired, use
|
|
<xref:SkiaSharp.SKCanvas.ClipRect(SkiaSharp.SKRect,SkiaSharp.SKClipOperation,System.Boolean)>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Scale(SkiaSharp.SKPoint)">
|
|
<param name="size">The amount to scale.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified scale.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Scale(System.Single)">
|
|
<param name="s">The amount to scale.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified scale.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Scale(System.Single,System.Single)">
|
|
<param name="sx">The amount to scale in the x-direction.</param>
|
|
<param name="sy">The amount to scale in the y-direction.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified scale.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Scale(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="sx">The amount to scale in the x-direction.</param>
|
|
<param name="sy">The amount to scale in the y-direction.</param>
|
|
<param name="px">The x-coordinate for the scaling center.</param>
|
|
<param name="py">The y-coordinate for the scaling center.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified scale, at the specific offset.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.SetMatrix(SkiaSharp.SKMatrix)">
|
|
<param name="matrix">The matrix that will be copied into the current matrix.</param>
|
|
<summary>Replaces the current matrix with a copy of the specified matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Skew(SkiaSharp.SKPoint)">
|
|
<param name="skew">The amount to skew.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified skew.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Skew(System.Single,System.Single)">
|
|
<param name="sx">The amount to skew in the x-direction.</param>
|
|
<param name="sy">The amount to skew in the y-direction.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified skew.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCanvas.TotalMatrix">
|
|
<summary>Gets the current matrix on the canvas.</summary>
|
|
<value />
|
|
<remarks>This does not account for the translate in any of the devices.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Translate(SkiaSharp.SKPoint)">
|
|
<param name="point">The distance to translate.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified translation.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCanvas.Translate(System.Single,System.Single)">
|
|
<param name="dx">The distance to translate in the x-direction</param>
|
|
<param name="dy">The distance to translate in the y-direction.</param>
|
|
<summary>Pre-concatenates the current matrix with the specified translation.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKClipOperation">
|
|
<summary>The logical operations that can be performed when combining two regions.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKClipOperation.Difference">
|
|
<summary>Subtract the op region from the first region.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKClipOperation.Intersect">
|
|
<summary>Intersect the two regions.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKCodec">
|
|
<summary>An abstraction layer directly on top of an image codec.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.Create(SkiaSharp.SKData)">
|
|
<param name="data">The data to use when creating the codec.</param>
|
|
<summary>Creates a codec from the specified data.</summary>
|
|
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.Create(SkiaSharp.SKStream)">
|
|
<param name="stream">The stream to use when creating the codec.</param>
|
|
<summary>Creates a codec from the specified stream.</summary>
|
|
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
|
|
<remarks>If <see langword="null" /> is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.Create(System.IO.Stream)">
|
|
<param name="stream">The stream to use when creating the codec.</param>
|
|
<summary>Creates a codec from the specified stream.</summary>
|
|
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
|
|
<remarks>If <see langword="null" /> is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.Create(System.String)">
|
|
<param name="filename">The path to an encoded image on the file system.</param>
|
|
<summary>Creates a codec from the specified file.</summary>
|
|
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.Create(SkiaSharp.SKStream,SkiaSharp.SKCodecResult@)">
|
|
<param name="stream">The stream to use when creating the codec.</param>
|
|
<param name="result">The result of the creation operation.</param>
|
|
<summary>Creates a codec from the specified stream.</summary>
|
|
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
|
|
<remarks>If <see langword="null" /> is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.Create(System.IO.Stream,SkiaSharp.SKCodecResult@)">
|
|
<param name="stream">The stream to use when creating the codec.</param>
|
|
<param name="result">The result of the creation operation.</param>
|
|
<summary>Creates a codec from the specified stream.</summary>
|
|
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
|
|
<remarks>If <see langword="null" /> is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.Create(System.String,SkiaSharp.SKCodecResult@)">
|
|
<param name="filename">The path to an encoded image on the file system.</param>
|
|
<param name="result">The result of the creation operation.</param>
|
|
<summary>Creates a codec from the specified file.</summary>
|
|
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKCodec" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKCodec" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.EncodedFormat">
|
|
<summary>Gets the image encoding from the codec.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.EncodedInfo">
|
|
<summary>Gets the encoded image information from the codec.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.EncodedOrigin">
|
|
<summary>Gets the image origin from the codec.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.FrameCount">
|
|
<summary>Gets the number of frames in the encoded image.</summary>
|
|
<value />
|
|
<remarks>May require reading through the stream to determine info about the frames. As such, future decoding calls may require a rewind. For single-frame images, this will be zero.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.FrameInfo">
|
|
<summary>Gets information about the frames in the encoded image.</summary>
|
|
<value />
|
|
<remarks>May require reading through the stream to determine info about the frames. As such, future decoding calls may require a rewind. For single-frame images, this will be an empty array.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetFrameInfo(System.Int32,SkiaSharp.SKCodecFrameInfo@)">
|
|
<param name="index">The index of the frame to retrieve.</param>
|
|
<param name="frameInfo">The information about the frame.</param>
|
|
<summary>Gets information about a specific frame in the encoded image.</summary>
|
|
<returns>Returns true if the frame was successfully read, otherwise false.</returns>
|
|
<remarks>May require reading through the stream to determine info about the frames. As such, future decoding calls may require a rewind.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetOutputScanline(System.Int32)">
|
|
<param name="inputScanline">The scanline that is located in the encoded data.</param>
|
|
<summary>Returns the output y-coordinate of the row that corresponds to an input y-coordinate.</summary>
|
|
<returns>Returns the output y-coordinate of the row.</returns>
|
|
<remarks>This will equal <paramref name="inputScanline" />, except in the case of strangely encoded image types (bottom-up BMPs, interlaced GIFs).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(System.Byte[]@)">
|
|
<param name="pixels">The memory block with the decoded bitmap.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.Byte[])">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a length of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.Byte[]@)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block with the decoded bitmap.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a total size of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKCodecOptions)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a total size of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<param name="options">The bitmap decoding options.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKColorTable,System.Int32@)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a total size of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<param name="colorTable">The color table to hold the color entries.</param>
|
|
<param name="colorTableCount">The logical number of color table entries.</param>
|
|
<summary>Developers should not use this obsolete method.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKCodecOptions)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a total size of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<param name="rowBytes">The number of bytes in a row, typically <see cref="P:SkiaSharp.SKImageInfo.RowBytes" />.</param>
|
|
<param name="options">The bitmap decoding options.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.IntPtr,System.Int32@)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a total size of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<param name="colorTable">The pointer to the color table to hold the color entries, with a length of at least <see cref="F:SkiaSharp.SKColorTable.MaxLength" /> (256).</param>
|
|
<param name="colorTableCount">The logical number of color table entries.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKCodecOptions,SkiaSharp.SKColorTable,System.Int32@)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a total size of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<param name="options">The bitmap decoding options.</param>
|
|
<param name="colorTable">The color table to hold the color entries.</param>
|
|
<param name="colorTableCount">The logical number of color table entries.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKCodecOptions,System.IntPtr,System.Int32@)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a total size of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<param name="options">The bitmap decoding options.</param>
|
|
<param name="colorTable">The pointer to the color table to hold the color entries, with a length of at least <see cref="F:SkiaSharp.SKColorTable.MaxLength" /> (256).</param>
|
|
<param name="colorTableCount">The logical number of color table entries.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
|
|
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKCodecOptions,SkiaSharp.SKColorTable,System.Int32@)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a total size of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<param name="rowBytes">The number of bytes in a row, typically <see cref="P:SkiaSharp.SKImageInfo.RowBytes" />.</param>
|
|
<param name="options">The bitmap decoding options.</param>
|
|
<param name="colorTable">The color table to hold the color entries.</param>
|
|
<param name="colorTableCount">The logical number of color table entries.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKCodecOptions,System.IntPtr,System.Int32@)">
|
|
<param name="info">The description of the desired output format expected by the caller.</param>
|
|
<param name="pixels">The memory block to hold the decoded bitmap, with a total size of at least <see cref="P:SkiaSharp.SKImageInfo.BytesSize" />.</param>
|
|
<param name="rowBytes">The number of bytes in a row, typically <see cref="P:SkiaSharp.SKImageInfo.RowBytes" />.</param>
|
|
<param name="options">The bitmap decoding options.</param>
|
|
<param name="colorTable">The pointer to the color table to hold the color entries, with a length of at least <see cref="F:SkiaSharp.SKColorTable.MaxLength" /> (256).</param>
|
|
<param name="colorTableCount">The logical number of color table entries.</param>
|
|
<summary>Decode the bitmap into the specified memory block.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The specified <xref:SkiaSharp.SKImageInfo>, can either be
|
|
<xref:SkiaSharp.SKCodec.Info>, or a new instance with a different
|
|
configuration - which the codec may choose to ignore.
|
|
|
|
If the specified size is different from the size from
|
|
<xref:SkiaSharp.SKCodec.Info>, then the codec will attempt to scale the
|
|
resulting bitmap. If the codec cannot perform this scale, this method will
|
|
return <xref:SkiaSharp.SKCodecResult.InvalidScale>.
|
|
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetScaledDimensions(System.Single)">
|
|
<param name="desiredScale">The desired scale factor.</param>
|
|
<summary>Returns a size that approximately supports the desired scale factor.</summary>
|
|
<returns>Returns a supported size.</returns>
|
|
<remarks>The codec may not be able to scale efficiently to the exact scale factor requested, so return a size that approximates that scale. Upscaling is not supported, so the original size will be returned.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetScanlines(System.IntPtr,System.Int32,System.Int32)">
|
|
<param name="dst">The memory location to store the scanlines.</param>
|
|
<param name="countLines">The number of lines to write.</param>
|
|
<param name="rowBytes">The number of bytes per row.</param>
|
|
<summary>Writes the next set of scanlines into the destination.</summary>
|
|
<returns>Returns the number of lines successfully decoded.</returns>
|
|
<remarks>If number of lines successfully decoded is less than <paramref name="countLines" />, this will fill the remaining lines with a default value.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.GetValidSubset(SkiaSharp.SKRectI@)">
|
|
<param name="desiredSubset">The desired subset of the original bounds, which may be modified to a subset which is supported.</param>
|
|
<summary>Modifies the specified subset to one that can decoded from this codec.</summary>
|
|
<returns>Returns true if this codec supports decoding the desired subset, otherwise false. The final subset can be used with <see cref="P:SkiaSharp.SKCodecOptions.Subset" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.IncrementalDecode">
|
|
<summary>Start or continue the incremental decode.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> if all lines requested in <see cref="M:SkiaSharp.SKCodec.StartIncrementalDecode(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)" /> have been completely decoded. <see cref="F:SkiaSharp.SKCodecResult.IncompleteInput" /> otherwise.</returns>
|
|
<remarks>Unlike <see cref="M:SkiaSharp.SKCodec.GetPixels(System.Byte[]@)" />, this does not do any filling. This is left up to the caller, since they may be skipping lines or continuing the decode later.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.IncrementalDecode(System.Int32@)">
|
|
<param name="rowsDecoded">The total number of lines initialized. Only meaningful if this method returns <see cref="F:SkiaSharp.SKCodecResult.IncompleteInput" />.</param>
|
|
<summary>Start or continue the incremental decode.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> if all lines requested in <see cref="M:SkiaSharp.SKCodec.StartIncrementalDecode(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)" /> have been completely decoded. <see cref="F:SkiaSharp.SKCodecResult.IncompleteInput" /> otherwise.</returns>
|
|
<remarks>Unlike <see cref="M:SkiaSharp.SKCodec.GetPixels(System.Byte[]@)" />, this does not do any filling. This is left up to the caller, since they may be skipping lines or continuing the decode later.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.Info">
|
|
<summary>Gets the image information from the codec.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.MinBufferedBytesNeeded">
|
|
<summary>Gets the minimum number of bytes that must be buffered in stream input.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.NextScanline">
|
|
<summary>Gets the y-coordinate of the next row to be returned by the scanline decoder.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.Origin">
|
|
<summary>Gets the image origin from the codec.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.Pixels">
|
|
<summary>Gets the image data from the codec using the current <see cref="P:SkiaSharp.SKCodec.Info" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.RepetitionCount">
|
|
<summary>Gets the number of times to repeat, if this image is animated.</summary>
|
|
<value />
|
|
<remarks>
|
|
<para>For infinite repetition of frames, this will be -1.</para>
|
|
<para>May require reading the stream to find the repetition count. As such, future decoding calls may require a rewind. For single-frame images, this will be 0.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodec.ScanlineOrder">
|
|
<summary>Gets the order in which scanlines will be returned by the scanline decoder.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.SkipScanlines(System.Int32)">
|
|
<param name="countLines">The number of scanlines to skip.</param>
|
|
<summary>Skip the specified number of scanlines.</summary>
|
|
<returns>Returns <see langword="true" /> if the scanlines were successfully skipped, otherwise <see langword="false" /> on failure (incomplete input, the number of lines is less than zero, read all the lines).</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.StartIncrementalDecode(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)">
|
|
<param name="info">The image information of the destination. If the dimensions do not match those of <see cref="P:SkiaSharp.SKCodec.Info" />, this implies a scale.</param>
|
|
<param name="pixels">The memory to write to. Needs to be large enough to hold the subset, if present, or the full image.</param>
|
|
<param name="rowBytes">The stride of the memory to write to.</param>
|
|
<summary>Prepare for an incremental decode with the specified options.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.StartIncrementalDecode(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKCodecOptions)">
|
|
<param name="info">The image information of the destination. If the dimensions do not match those of <see cref="P:SkiaSharp.SKCodec.Info" />, this implies a scale.</param>
|
|
<param name="pixels">The memory to write to. Needs to be large enough to hold the subset, if present, or the full image.</param>
|
|
<param name="rowBytes">The stride of the memory to write to.</param>
|
|
<param name="options">The decoding options, including if memory is zero initialized and whether to decode a subset.</param>
|
|
<summary>Prepare for an incremental decode with the specified options.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.StartIncrementalDecode(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKCodecOptions,SkiaSharp.SKColorTable,System.Int32@)">
|
|
<param name="info">The image information of the destination. If the dimensions do not match those of <see cref="P:SkiaSharp.SKCodec.Info" />, this implies a scale.</param>
|
|
<param name="pixels">The memory to write to. Needs to be large enough to hold the subset, if present, or the full image.</param>
|
|
<param name="rowBytes">The stride of the memory to write to.</param>
|
|
<param name="options">The decoding options, including if memory is zero initialized and whether to decode a subset.</param>
|
|
<param name="colorTable">The color table to use.</param>
|
|
<param name="colorTableCount">The size of the color table.</param>
|
|
<summary>Prepare for an incremental decode with the specified options.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.StartIncrementalDecode(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKCodecOptions,System.IntPtr,System.Int32@)">
|
|
<param name="info">The image information of the destination. If the dimensions do not match those of <see cref="P:SkiaSharp.SKCodec.Info" />, this implies a scale.</param>
|
|
<param name="pixels">The memory to write to. Needs to be large enough to hold the subset, if present, or the full image.</param>
|
|
<param name="rowBytes">The stride of the memory to write to.</param>
|
|
<param name="options">The decoding options, including if memory is zero initialized and whether to decode a subset.</param>
|
|
<param name="colorTable">The pointer to the color table to use.</param>
|
|
<param name="colorTableCount">The size of the color table.</param>
|
|
<summary>Prepare for an incremental decode with the specified options.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.StartScanlineDecode(SkiaSharp.SKImageInfo)">
|
|
<param name="info">The image information of the destination. If the dimensions do not match those of <see cref="P:SkiaSharp.SKCodec.Info" />, this implies a scale.</param>
|
|
<summary>Prepare for a scanline decode.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>Not all codecs support this.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.StartScanlineDecode(SkiaSharp.SKImageInfo,SkiaSharp.SKCodecOptions)">
|
|
<param name="info">The image information of the destination. If the dimensions do not match those of <see cref="P:SkiaSharp.SKCodec.Info" />, this implies a scale.</param>
|
|
<param name="options">The decoding options, including if memory is zero initialized and whether to decode a subset.</param>
|
|
<summary>Prepare for a scanline decode with the specified options.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>Not all codecs support this.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.StartScanlineDecode(SkiaSharp.SKImageInfo,SkiaSharp.SKCodecOptions,SkiaSharp.SKColorTable,System.Int32@)">
|
|
<param name="info">The image information of the destination. If the dimensions do not match those of <see cref="P:SkiaSharp.SKCodec.Info" />, this implies a scale.</param>
|
|
<param name="options">The decoding options, including if memory is zero initialized and whether to decode a subset.</param>
|
|
<param name="colorTable">The color table to use.</param>
|
|
<param name="colorTableCount">The size of the color table.</param>
|
|
<summary>Prepare for a scanline decode with the specified options.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>Not all codecs support this.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodec.StartScanlineDecode(SkiaSharp.SKImageInfo,SkiaSharp.SKCodecOptions,System.IntPtr,System.Int32@)">
|
|
<param name="info">The image information of the destination. If the dimensions do not match those of <see cref="P:SkiaSharp.SKCodec.Info" />, this implies a scale.</param>
|
|
<param name="options">The decoding options, including if memory is zero initialized and whether to decode a subset.</param>
|
|
<param name="colorTable">The pointer to the color table to use.</param>
|
|
<param name="colorTableCount">The size of the color table.</param>
|
|
<summary>Prepare for a scanline decode with the specified options.</summary>
|
|
<returns>Returns <see cref="F:SkiaSharp.SKCodecResult.Success" /> on success, or another value explaining the type of failure.</returns>
|
|
<remarks>Not all codecs support this.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKCodecAnimationDisposalMethod">
|
|
<summary>Represents how the next frame in the image is based on the current frame.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecAnimationDisposalMethod.Keep">
|
|
<summary>The next frame should be drawn on top of this one.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecAnimationDisposalMethod.RestoreBackgroundColor">
|
|
<summary>The area inside this frame's rectangle should be cleared to the background color before drawing the next frame.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecAnimationDisposalMethod.RestorePrevious">
|
|
<summary>The next frame should be drawn on top of the previous frame - i.e. disregarding this one.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKCodecFrameInfo">
|
|
<summary>Information about individual frames in a multi-framed image.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecFrameInfo.AlphaType">
|
|
<summary>Gets or sets a value indicating the frame's alpha value.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecFrameInfo.DisposalMethod">
|
|
<summary>Gets or sets the method indicating how the current frame should be modified before decoding the next one.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecFrameInfo.Duration">
|
|
<summary>Gets or sets the number of milliseconds to show this frame.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecFrameInfo.Equals(SkiaSharp.SKCodecFrameInfo)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecFrameInfo.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecFrameInfo.FullyRecieved">
|
|
<summary>Gets or sets a value indicating whether the end marker for this frame is contained in the stream.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecFrameInfo.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecFrameInfo.op_Equality(SkiaSharp.SKCodecFrameInfo,SkiaSharp.SKCodecFrameInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecFrameInfo.op_Inequality(SkiaSharp.SKCodecFrameInfo,SkiaSharp.SKCodecFrameInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecFrameInfo.RequiredFrame">
|
|
<summary>Gets or sets the frame that this frame needs to be blended with, or -1.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKCodecOptions">
|
|
<summary>Additional options to pass to <see cref="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKCodecOptions)" /> or one of the overloads that accepts a <see cref="T:SkiaSharp.SKCodecOptions" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKCodecOptions(SkiaSharp.SKRectI)">
|
|
<param name="subset">The subset rectangle.</param>
|
|
<summary>Create a new instance of <see cref="T:SkiaSharp.SKCodecOptions" /> with the specified subset rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKCodecOptions(SkiaSharp.SKZeroInitialized)">
|
|
<param name="zeroInitialized">The zero-initialization.</param>
|
|
<summary>Create a new instance of <see cref="T:SkiaSharp.SKCodecOptions" /> with the specified zero-initialization.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKCodecOptions(System.Int32)">
|
|
<param name="frameIndex">The frame to decode.</param>
|
|
<summary>Create a new instance of <see cref="T:SkiaSharp.SKCodecOptions" /> with the specified frame index.</summary>
|
|
<remarks>Only meaningful for multi-frame images.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKCodecOptions(SkiaSharp.SKZeroInitialized,SkiaSharp.SKRectI)">
|
|
<param name="zeroInitialized">The zero-initialization.</param>
|
|
<param name="subset">The subset rectangle.</param>
|
|
<summary>Create a new instance of <see cref="T:SkiaSharp.SKCodecOptions" /> with the specified subset rectangle and zero-initialization.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKCodecOptions(System.Int32,System.Boolean)">
|
|
<param name="frameIndex">The frame to decode.</param>
|
|
<param name="hasPriorFrame">Whether the decode destination already contains the prior frame.</param>
|
|
<summary>Create a new instance of <see cref="T:SkiaSharp.SKCodecOptions" />.</summary>
|
|
<remarks>Only meaningful for multi-frame images.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKCodecOptions(System.Int32,System.Int32)">
|
|
<param name="frameIndex">The frame to decode.</param>
|
|
<param name="priorFrame">The previous frame to decode.</param>
|
|
<summary>Create a new instance of <see cref="T:SkiaSharp.SKCodecOptions" />.</summary>
|
|
<remarks>Only meaningful for multi-frame images.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecOptions.Default">
|
|
<summary>Gets the default options.</summary>
|
|
<remarks>The default value is not zero-initialized and without a subset rectangle.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecOptions.Equals(SkiaSharp.SKCodecOptions)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecOptions.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecOptions.FrameIndex">
|
|
<summary>Gets or sets the frame to decode.</summary>
|
|
<value />
|
|
<remarks>Only meaningful for multi-frame images.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecOptions.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecOptions.HasPriorFrame">
|
|
<summary>Gets or sets a value indicating whether the decode destination already contains the prior frame.</summary>
|
|
<value />
|
|
<remarks>Only meaningful for multi-frame images.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecOptions.HasSubset">
|
|
<summary>Gets a value indicating whether the options has a subset rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecOptions.op_Equality(SkiaSharp.SKCodecOptions,SkiaSharp.SKCodecOptions)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKCodecOptions.op_Inequality(SkiaSharp.SKCodecOptions,SkiaSharp.SKCodecOptions)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecOptions.PremulBehavior">
|
|
<summary>Gets or sets a value indicating whether the decode should do a linear premultiply or a legacy premultiply.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecOptions.PriorFrame">
|
|
<summary>Gets or sets a value indicating which frame, if any, the destination bitmap already contains.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Only meaningful for multi-frame images.
|
|
|
|
If <xref:SkiaSharp.SKCodecOptions.FrameIndex> needs to be blended with a prior
|
|
frame (as reported by `SKCodec.FrameInfo[FrameIndex].RequiredFrame`), the
|
|
client can set this to any non-<xref:SkiaSharp.SKCodecAnimationDisposalMethod.RestorePrevious>
|
|
frame in the range [RequiredFrame, FrameIndex) to indicate that that frame is
|
|
already in the destination. <xref:SkiaSharp.SKCodecOptions.ZeroInitialized> is
|
|
ignored in this case.
|
|
|
|
If set to -1, the codec will decode any necessary required frame(s) first.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecOptions.Subset">
|
|
<summary>Gets or sets the subset rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKCodecOptions.ZeroInitialized">
|
|
<summary>Gets or sets the zero-initialization.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKCodecOrigin">
|
|
<summary>The various origins of a bitmap.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecOrigin.BottomLeft">
|
|
<summary>Reflected across x-axis.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecOrigin.BottomRight">
|
|
<summary>Rotated 180°.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecOrigin.LeftBottom">
|
|
<summary>Rotated 90° counter-clockwise.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecOrigin.LeftTop">
|
|
<summary>Reflected across x-axis, Rotated 90° counter-clockwise.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecOrigin.RightBottom">
|
|
<summary>Reflected across x-axis, Rotated 90° clockwise.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecOrigin.RightTop">
|
|
<summary>Rotated 90° clockwise.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecOrigin.TopLeft">
|
|
<summary>Default.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecOrigin.TopRight">
|
|
<summary>Reflected across y-axis.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKCodecResult">
|
|
<summary>Used to describe the result of a call to <see cref="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKCodecOptions)" /> or one of the overloads that accepts a <see cref="T:SkiaSharp.SKCodecOptions" />.</summary>
|
|
<remarks>Result is the union of possible results from subclasses.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.CouldNotRewind">
|
|
<summary>Fulfilling this request requires rewinding the input, which is not supported for this input.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.ErrorInInput">
|
|
<summary>There was an error in the imput data. If returned from an incremental decode, decoding cannot continue, even with more data.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.IncompleteInput">
|
|
<summary>The input is incomplete. A partial image was generated.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.InternalError">
|
|
<summary>An internal memory occurred, such as an out-of-memory error.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.InvalidConversion">
|
|
<summary>The codec cannot convert to match the request, ignoring dimensions.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.InvalidInput">
|
|
<summary>The input did not contain a valid image.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.InvalidParameters">
|
|
<summary>The parameters (besides info) are invalid. e.g. null pixels, row bytes too small, etc.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.InvalidScale">
|
|
<summary>The generator cannot scale to requested size.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.Success">
|
|
<summary>The general return value for success.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecResult.Unimplemented">
|
|
<summary>This method is not supported by this codec.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKCodecScanlineOrder">
|
|
<summary>The orders in which scanlines can be returned.</summary>
|
|
<remarks>These values are obtained through the <see cref="P:SkiaSharp.SKCodec.ScanlineOrder" /> property.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecScanlineOrder.BottomUp">
|
|
<summary>Indicates that the scanline decoder reliably outputs rows, but they will be returned in reverse order. The <see cref="P:SkiaSharp.SKCodec.NextScanline" /> property can be used to determine the actual y-coordinate of the next output row.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCodecScanlineOrder.TopDown">
|
|
<summary>Indicates that the image can be decoded reliably using the scanline decoder, and that rows will be output in the logical order.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColor">
|
|
<summary>32-bit ARGB unpremultiplied color value.</summary>
|
|
<remarks>The color components are always in a known order.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColor(System.UInt32)">
|
|
<param name="value">The integer value of the unpremultiplied color.</param>
|
|
<summary>Creates a color from the specified integer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColor(System.Byte,System.Byte,System.Byte)">
|
|
<param name="red">The red component.</param>
|
|
<param name="green">The green component.</param>
|
|
<param name="blue">The blue component.</param>
|
|
<summary>Creates a color from the specified red, green and blue components.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColor(System.Byte,System.Byte,System.Byte,System.Byte)">
|
|
<param name="red">The red component.</param>
|
|
<param name="green">The green component.</param>
|
|
<param name="blue">The blue component.</param>
|
|
<param name="alpha">The alpha component.</param>
|
|
<summary>Creates a color from the specified red, green, blue and alpha components.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColor.Alpha">
|
|
<summary>Gets the alpha component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColor.Blue">
|
|
<summary>Gets the blue component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColor.Empty">
|
|
<summary>Gets an "empty" color, with zero for all the components.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.Equals(SkiaSharp.SKColor)">
|
|
<param name="obj">The color to compare with the current color.</param>
|
|
<summary>Determines whether the specified object is equal to the current object.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.Equals(System.Object)">
|
|
<param name="other">The object to compare with the current object.</param>
|
|
<summary>Determines whether the specified object is equal to the current object.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.FromHsl(System.Single,System.Single,System.Single,System.Byte)">
|
|
<param name="h">The hue value.</param>
|
|
<param name="s">The saturation value.</param>
|
|
<param name="l">The lightness/luminosity value.</param>
|
|
<param name="a">The alpha value.</param>
|
|
<summary>Creates a color from the specified hue, saturation, lightness/luminosity and alpha values.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKColor" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.FromHsv(System.Single,System.Single,System.Single,System.Byte)">
|
|
<param name="h">The hue value.</param>
|
|
<param name="s">The saturation value.</param>
|
|
<param name="v">The value/brightness value.</param>
|
|
<param name="a">The alpha value.</param>
|
|
<summary>Creates a color from the specified hue, saturation, value/brightness and alpha values.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKColor" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.GetHashCode">
|
|
<summary>Serves as the default hash function.</summary>
|
|
<returns>Returns a hash code for the current object.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColor.Green">
|
|
<summary>Gets the green component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColor.Hue">
|
|
<summary>Gets the hue value.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.op_Equality(SkiaSharp.SKColor,SkiaSharp.SKColor)">
|
|
<param name="left">The first color to compare.</param>
|
|
<param name="right">The second color to compare.</param>
|
|
<summary>Indicates whether two <see cref="T:SkiaSharp.SKColor" /> objects are equal.</summary>
|
|
<returns>Returns <see langword="true" /> if <paramref name="left" /> is equal to <paramref name="right" />, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.op_Explicit(SkiaSharp.SKColor)~System.UInt32">
|
|
<param name="color">The color to convert.</param>
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKColor" /> to a UInt32.</summary>
|
|
<returns>The UInt32 value for the color.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.op_Implicit(System.UInt32)~SkiaSharp.SKColor">
|
|
<param name="color">The UInt32 representation of a color.</param>
|
|
<summary>Converts a UInt32 to a <see cref="T:SkiaSharp.SKColor" />.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKColor" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.op_Inequality(SkiaSharp.SKColor,SkiaSharp.SKColor)">
|
|
<param name="left">The first color to compare.</param>
|
|
<param name="right">The second color to compare.</param>
|
|
<summary>Indicates whether two <see cref="T:SkiaSharp.SKColor" /> objects are different.</summary>
|
|
<returns>Returns <see langword="true" /> if <paramref name="left" /> is not equal to <paramref name="right" />, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.Parse(System.String)">
|
|
<param name="hexString">The hexadecimal string representation of a color.</param>
|
|
<summary>Converts the hexadecimal string representation of a color to its <see cref="T:SkiaSharp.SKColor" /> equivalent.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKColor" /> instance.</returns>
|
|
<remarks>This method can parse a string in the forms with or without a preceding '#' character: AARRGGB, RRGGBB, ARGB, RGB.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColor.Red">
|
|
<summary>Gets the red component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.ToHsl(System.Single@,System.Single@,System.Single@)">
|
|
<param name="h">The hue value.</param>
|
|
<param name="s">The saturation value.</param>
|
|
<param name="l">The lightness/luminosity value.</param>
|
|
<summary>Converts the current color into it's hue, saturation and lightness/luminosity values.</summary>
|
|
<remarks>The alpha value is separate from the HSL calculation and will always be the same as <see cref="P:SkiaSharp.SKColor.Alpha" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.ToHsv(System.Single@,System.Single@,System.Single@)">
|
|
<param name="h">The hue value.</param>
|
|
<param name="s">The saturation value.</param>
|
|
<param name="v">The value/brightness value.</param>
|
|
<summary>Converts the current color into it's hue, saturation and value/brightness values.</summary>
|
|
<remarks>The alpha value is separate from the HSV/HSB calculation and will always be the same as <see cref="P:SkiaSharp.SKColor.Alpha" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.ToString">
|
|
<summary>Returns the color as a string in the format: #AARRGGBB.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.TryParse(System.String,SkiaSharp.SKColor@)">
|
|
<param name="hexString">The hexadecimal string representation of a color.</param>
|
|
<param name="color">The new <see cref="T:SkiaSharp.SKColor" /> instance.</param>
|
|
<summary>Converts the hexadecimal string representation of a color to its <see cref="T:SkiaSharp.SKColor" /> equivalent.</summary>
|
|
<returns>Returns true if the conversion was successful, otherwise false.</returns>
|
|
<remarks>This method can parse a string in the forms with or without a preceding '#' character: AARRGGB, RRGGBB, ARGB, RGB.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.WithAlpha(System.Byte)">
|
|
<param name="alpha">The new alpha component.</param>
|
|
<summary>Returns a new color based on this current instance, but with the new alpha channel value.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.WithBlue(System.Byte)">
|
|
<param name="blue">The new blue component.</param>
|
|
<summary>Returns a new color based on this current instance, but with the new blue channel value.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.WithGreen(System.Byte)">
|
|
<param name="green">The new green component.</param>
|
|
<summary>Returns a new color based on this current instance, but with the new green channel value.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColor.WithRed(System.Byte)">
|
|
<param name="red">The new red component.</param>
|
|
<summary>Returns a new color based on this current instance, but with the new red channel value.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorChannel">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorChannel.A">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorChannel.B">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorChannel.G">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorChannel.R">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorF">
|
|
<summary>16-bit, floating-point, ARGB unpremultiplied color value.</summary>
|
|
<remarks>The color components are always in a known order.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorF(System.Single,System.Single,System.Single)">
|
|
<param name="red">The red component.</param>
|
|
<param name="green">The green component.</param>
|
|
<param name="blue">The blue component.</param>
|
|
<summary>Creates a color from the specified red, green and blue components.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorF(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="red">The red component.</param>
|
|
<param name="green">The green component.</param>
|
|
<param name="blue">The blue component.</param>
|
|
<param name="alpha">The alpha component.</param>
|
|
<summary>Creates a color from the specified red, green, blue and alpha components.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorF.Alpha">
|
|
<summary>Gets the alpha component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorF.Blue">
|
|
<summary>Gets the blue component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.Clamp">
|
|
<summary>Clamp the color components in the range [0..1].</summary>
|
|
<returns>Returns the clamped color.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorF.Empty">
|
|
<summary>Gets an "empty" color, with zero for all the components.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.Equals(SkiaSharp.SKColorF)">
|
|
<param name="obj">The color to compare with the current color.</param>
|
|
<summary>Determines whether the specified object is equal to the current object.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.Equals(System.Object)">
|
|
<param name="obj">The object to compare with the current object.</param>
|
|
<summary>Determines whether the specified object is equal to the current object.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.FromHsl(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="h">The hue value.</param>
|
|
<param name="s">The saturation value.</param>
|
|
<param name="l">The lightness/luminosity value.</param>
|
|
<param name="a">The alpha value.</param>
|
|
<summary>Creates a color from the specified hue, saturation, lightness/luminosity and alpha values.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKColorF" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.FromHsv(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="h">The hue value.</param>
|
|
<param name="s">The saturation value.</param>
|
|
<param name="v">The value/brightness value.</param>
|
|
<param name="a">The alpha value.</param>
|
|
<summary>Creates a color from the specified hue, saturation, value/brightness and alpha values.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKColorF" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.GetHashCode">
|
|
<summary>Serves as the default hash function.</summary>
|
|
<returns>Returns a hash code for the current object.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorF.Green">
|
|
<summary>Gets the green component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorF.Hue">
|
|
<summary>Gets the hue value.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.op_Equality(SkiaSharp.SKColorF,SkiaSharp.SKColorF)">
|
|
<param name="left">The first color to compare.</param>
|
|
<param name="right">The second color to compare.</param>
|
|
<summary>Indicates whether two <see cref="T:SkiaSharp.SKColorF" /> objects are equal.</summary>
|
|
<returns>Returns <see langword="true" /> if <paramref name="left" /> is equal to <paramref name="right" />, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.op_Explicit(SkiaSharp.SKColorF)~SkiaSharp.SKColor">
|
|
<param name="color">The color to convert.</param>
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKColorF" /> to a <see cref="T:SkiaSharp.SKColor" />.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKColor" />.</returns>
|
|
<remarks>As a result of converting a floating-point color to an integer color, some data loss will occur.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.op_Implicit(SkiaSharp.SKColor)~SkiaSharp.SKColorF">
|
|
<param name="color">The <see cref="T:SkiaSharp.SKColor" />.</param>
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKColor" /> to a <see cref="T:SkiaSharp.SKColorF" />.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKColorF" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.op_Inequality(SkiaSharp.SKColorF,SkiaSharp.SKColorF)">
|
|
<param name="left">The first color to compare.</param>
|
|
<param name="right">The second color to compare.</param>
|
|
<summary>Indicates whether two <see cref="T:SkiaSharp.SKColorF" /> objects are different.</summary>
|
|
<returns>Returns <see langword="true" /> if <paramref name="left" /> is not equal to <paramref name="right" />, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorF.Red">
|
|
<summary>Gets the red component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.ToHsl(System.Single@,System.Single@,System.Single@)">
|
|
<param name="h">The hue value.</param>
|
|
<param name="s">The saturation value.</param>
|
|
<param name="l">The lightness/luminosity value.</param>
|
|
<summary>Converts the current color into it's hue, saturation and lightness/luminosity values.</summary>
|
|
<remarks>The alpha value is separate from the HSL calculation and will always be the same as <see cref="P:SkiaSharp.SKColorF.Alpha" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.ToHsv(System.Single@,System.Single@,System.Single@)">
|
|
<param name="h">The hue value.</param>
|
|
<param name="s">The saturation value.</param>
|
|
<param name="v">The value/brightness value.</param>
|
|
<summary>Converts the current color into it's hue, saturation and value/brightness values.</summary>
|
|
<remarks>The alpha value is separate from the HSV/HSB calculation and will always be the same as <see cref="P:SkiaSharp.SKColorF.Alpha" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.ToString">
|
|
<summary>Returns the color as a string in the format: #AARRGGBB.</summary>
|
|
<returns />
|
|
<remarks>As a result of converting a floating-point color to an integer color, some data loss will occur.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.WithAlpha(System.Single)">
|
|
<param name="alpha">The new alpha component.</param>
|
|
<summary>Returns a new color based on this current instance, but with the new alpha channel value.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.WithBlue(System.Single)">
|
|
<param name="blue">The new blue component.</param>
|
|
<summary>Returns a new color based on this current instance, but with the new blue channel value.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.WithGreen(System.Single)">
|
|
<param name="green">The new green component.</param>
|
|
<summary>Returns a new color based on this current instance, but with the new green channel value.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorF.WithRed(System.Single)">
|
|
<param name="red">The new red component.</param>
|
|
<summary>Returns a new color based on this current instance, but with the new red channel value.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorFilter">
|
|
<summary>Color filters for use with the <see cref="P:SkiaSharp.SKPaint.ColorFilter" /> property of a <see cref="T:SkiaSharp.SKPaint" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorFilter.ColorMatrixSize">
|
|
<summary>The size of the color matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.CreateBlendMode(SkiaSharp.SKColor,SkiaSharp.SKBlendMode)">
|
|
<param name="c">The source color used with the specified mode.</param>
|
|
<param name="mode">The blend mode mode that is applied to each color.</param>
|
|
<summary>Creates a new color filter that uses the specified color and mode.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />, or <see langword="null" /> if the mode will have no effect.</returns>
|
|
<remarks>If the <paramref name="mode" /> is <see cref="F:SkiaSharp.SKBlendMode.Dst" />, this function will return <see langword="null" /> (since that mode will have no effect on the result).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.CreateColorMatrix(System.Single[])">
|
|
<param name="matrix">An array of <see cref="F:SkiaSharp.SKColorFilter.ColorMatrixSize" /> elements.</param>
|
|
<summary>Creates a new color filter that transforms a color by a 4x5 (row-major) matrix.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
|
|
<remarks>The matrix is in row-major order and the translation column is specified in unnormalized, 0...255, space.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.CreateCompose(SkiaSharp.SKColorFilter,SkiaSharp.SKColorFilter)">
|
|
<param name="outer">The outer (second) filter to apply.</param>
|
|
<param name="inner">The inner (first) filter to apply.</param>
|
|
<summary>Creates a new composition color filter, whose effect is to first apply the inner filter and then apply the outer filter to the result of the inner.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.CreateHighContrast(SkiaSharp.SKHighContrastConfig)">
|
|
<param name="config">The high contrast configuration settings.</param>
|
|
<summary>Creates a new high contrast color filter which provides transformations to improve contrast for users with low vision.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
|
|
<remarks>Applies the following transformations in this order: conversion to grayscale, color inversion, increasing the resulting contrast.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.CreateHighContrast(System.Boolean,SkiaSharp.SKHighContrastConfigInvertStyle,System.Single)">
|
|
<param name="grayscale">Whether or not the color will be converted to grayscale.</param>
|
|
<param name="invertStyle">Whether or not to invert brightness, lightness, or neither.</param>
|
|
<param name="contrast">The amount to adjust the contrast by, in the range -1.0 through 1.0.</param>
|
|
<summary>Creates a new high contrast color filter which provides transformations to improve contrast for users with low vision.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
|
|
<remarks>Applies the following transformations in this order: conversion to grayscale, color inversion, increasing the resulting contrast.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.CreateLighting(SkiaSharp.SKColor,SkiaSharp.SKColor)">
|
|
<param name="mul">The color to multiply the source color by. The alpha component is ignored.</param>
|
|
<param name="add">The color to add to the source color. The alpha component is ignored.</param>
|
|
<summary>Creates a new lighting color filter that multiplies the RGB channels by one color, and then adds a second color, pinning the result for each component to [0..255].</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.CreateLumaColor">
|
|
<summary>Creates a new luminance-to-alpha color filter.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.CreateTable(System.Byte[])">
|
|
<param name="table">The table of values for each color component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
|
|
<summary>Creates a new table color filter.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.CreateTable(System.Byte[],System.Byte[],System.Byte[],System.Byte[])">
|
|
<param name="tableA">The table of values for the alpha component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
|
|
<param name="tableR">The table of values for the red component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
|
|
<param name="tableG">The table of values for the green component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
|
|
<param name="tableB">The table of values for the blue component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
|
|
<summary>Creates a new table color filter.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorFilter.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKColorFilter" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKColorFilter" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorFilter.TableMaxLength">
|
|
<summary>The size of a color table for a color component.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColors">
|
|
<summary>Definitions for some common color names.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.AliceBlue">
|
|
<summary>Gets the predefined color of alice blue, or #FFF0F8FF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.AntiqueWhite">
|
|
<summary>Gets the predefined color of antique white, or #FFFAEBD7.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Aqua">
|
|
<summary>Gets the predefined color of aqua, or #FF00FFFF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Aquamarine">
|
|
<summary>Gets the predefined color of aquamarine, or #FF7FFFD4.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Azure">
|
|
<summary>Gets the predefined color of azure, or #FFF0FFFF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Beige">
|
|
<summary>Gets the predefined color of beige, or #FFF5F5DC.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Bisque">
|
|
<summary>Gets the predefined color of bisque, or #FFFFE4C4.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Black">
|
|
<summary>Gets the predefined color of black, or #FF000000.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.BlanchedAlmond">
|
|
<summary>Gets the predefined color of blanched almond, or #FFFFEBCD.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Blue">
|
|
<summary>Gets the predefined color of blue, or #FF0000FF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.BlueViolet">
|
|
<summary>Gets the predefined color of blue violet, or #FF8A2BE2.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Brown">
|
|
<summary>Gets the predefined color of brown, or #FFA52A2A.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.BurlyWood">
|
|
<summary>Gets the predefined color of burly wood, or #FFDEB887.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.CadetBlue">
|
|
<summary>Gets the predefined color of cadet blue, or #FF5F9EA0.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Chartreuse">
|
|
<summary>Gets the predefined color of chartreuse, or #FF7FFF00.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Chocolate">
|
|
<summary>Gets the predefined color of chocolate, or #FFD2691E.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Coral">
|
|
<summary>Gets the predefined color of coral, or #FFFF7F50.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.CornflowerBlue">
|
|
<summary>Gets the predefined color of cornflower blue, or #FF6495ED.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Cornsilk">
|
|
<summary>Gets the predefined color of cornsilk, or #FFFFF8DC.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Crimson">
|
|
<summary>Gets the predefined color of crimson, or #FFDC143C.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Cyan">
|
|
<summary>Gets the predefined color of cyan, or #FF00FFFF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkBlue">
|
|
<summary>Gets the predefined color of dark blue, or #FF00008B.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkCyan">
|
|
<summary>Gets the predefined color of dark cyan, or #FF008B8B.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkGoldenrod">
|
|
<summary>Gets the predefined color of dark goldenrod, or #FFB8860B.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkGray">
|
|
<summary>Gets the predefined color of dark gray, or #FFA9A9A9.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkGreen">
|
|
<summary>Gets the predefined color of dark green, or #FF006400.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkKhaki">
|
|
<summary>Gets the predefined color of dark khaki, or #FFBDB76B.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkMagenta">
|
|
<summary>Gets the predefined color of dark magenta, or #FF8B008B.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkOliveGreen">
|
|
<summary>Gets the predefined color of dark olive green, or #FF556B2F.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkOrange">
|
|
<summary>Gets the predefined color of dark orange, or #FFFF8C00.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkOrchid">
|
|
<summary>Gets the predefined color of dark orchid, or #FF9932CC.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkRed">
|
|
<summary>Gets the predefined color of dark red, or #FF8B0000.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkSalmon">
|
|
<summary>Gets the predefined color of dark salmon, or #FFE9967A.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkSeaGreen">
|
|
<summary>Gets the predefined color of dark sea green, or #FF8FBC8B.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkSlateBlue">
|
|
<summary>Gets the predefined color of dark slate blue, or #FF483D8B.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkSlateGray">
|
|
<summary>Gets the predefined color of dark slate gray, or #FF2F4F4F.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkTurquoise">
|
|
<summary>Gets the predefined color of dark turquoise, or #FF00CED1.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DarkViolet">
|
|
<summary>Gets the predefined color of dark violet, or #FF9400D3.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DeepPink">
|
|
<summary>Gets the predefined color of deep pink, or #FFFF1493.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DeepSkyBlue">
|
|
<summary>Gets the predefined color of deep sky blue, or #FF00BFFF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DimGray">
|
|
<summary>Gets the predefined color of dim gray, or #FF696969.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.DodgerBlue">
|
|
<summary>Gets the predefined color of dodger blue, or #FF1E90FF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColors.Empty">
|
|
<summary>Gets the predefined empty color (black transparent), or #00000000.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Firebrick">
|
|
<summary>Gets the predefined color of firebrick, or #FFB22222.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.FloralWhite">
|
|
<summary>Gets the predefined color of floral white, or #FFFFFAF0.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.ForestGreen">
|
|
<summary>Gets the predefined color of forest green, or #FF228B22.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Fuchsia">
|
|
<summary>Gets the predefined color of fuchsia, or #FFFF00FF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Gainsboro">
|
|
<summary>Gets the predefined color of gainsboro, or #FFDCDCDC.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.GhostWhite">
|
|
<summary>Gets the predefined color of ghost white, or #FFF8F8FF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Gold">
|
|
<summary>Gets the predefined color of gold, or #FFFFD700.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Goldenrod">
|
|
<summary>Gets the predefined color of goldenrod, or #FFDAA520.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Gray">
|
|
<summary>Gets the predefined color of gray, or #FF808080.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Green">
|
|
<summary>Gets the predefined color of green, or #FF008000.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.GreenYellow">
|
|
<summary>Gets the predefined color of green yellow, or #FFADFF2F.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Honeydew">
|
|
<summary>Gets the predefined color of honeydew, or #FFF0FFF0.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.HotPink">
|
|
<summary>Gets the predefined color of hot pink, or #FFFF69B4.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.IndianRed">
|
|
<summary>Gets the predefined color of indian red, or #FFCD5C5C.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Indigo">
|
|
<summary>Gets the predefined color of indigo, or #FF4B0082.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Ivory">
|
|
<summary>Gets the predefined color of ivory, or #FFFFFFF0.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Khaki">
|
|
<summary>Gets the predefined color of khaki, or #FFF0E68C.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Lavender">
|
|
<summary>Gets the predefined color of lavender, or #FFE6E6FA.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LavenderBlush">
|
|
<summary>Gets the predefined color of lavender blush, or #FFFFF0F5.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LawnGreen">
|
|
<summary>Gets the predefined color of lawn green, or #FF7CFC00.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LemonChiffon">
|
|
<summary>Gets the predefined color of lemon chiffon, or #FFFFFACD.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightBlue">
|
|
<summary>Gets the predefined color of light blue, or #FFADD8E6.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightCoral">
|
|
<summary>Gets the predefined color of light coral, or #FFF08080.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightCyan">
|
|
<summary>Gets the predefined color of light cyan, or #FFE0FFFF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightGoldenrodYellow">
|
|
<summary>Gets the predefined color of light goldenrod yellow, or #FFFAFAD2.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightGray">
|
|
<summary>Gets the predefined color of light gray, or #FFD3D3D3.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightGreen">
|
|
<summary>Gets the predefined color of light green, or #FF90EE90.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightPink">
|
|
<summary>Gets the predefined color of light pink, or #FFFFB6C1.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightSalmon">
|
|
<summary>Gets the predefined color of light salmon, or #FFFFA07A.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightSeaGreen">
|
|
<summary>Gets the predefined color of light sea green, or #FF20B2AA.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightSkyBlue">
|
|
<summary>Gets the predefined color of light sky blue, or #FF87CEFA.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightSlateGray">
|
|
<summary>Gets the predefined color of light slate gray, or #FF778899.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightSteelBlue">
|
|
<summary>Gets the predefined color of light steel blue, or #FFB0C4DE.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LightYellow">
|
|
<summary>Gets the predefined color of light yellow, or #FFFFFFE0.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Lime">
|
|
<summary>Gets the predefined color of lime, or #FF00FF00.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.LimeGreen">
|
|
<summary>Gets the predefined color of lime green, or #FF32CD32.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Linen">
|
|
<summary>Gets the predefined color of linen, or #FFFAF0E6.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Magenta">
|
|
<summary>Gets the predefined color of magenta, or #FFFF00FF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Maroon">
|
|
<summary>Gets the predefined color of maroon, or #FF800000.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MediumAquamarine">
|
|
<summary>Gets the predefined color of medium aquamarine, or #FF66CDAA.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MediumBlue">
|
|
<summary>Gets the predefined color of medium blue, or #FF0000CD.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MediumOrchid">
|
|
<summary>Gets the predefined color of medium orchid, or #FFBA55D3.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MediumPurple">
|
|
<summary>Gets the predefined color of medium purple, or #FF9370DB.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MediumSeaGreen">
|
|
<summary>Gets the predefined color of medium sea green, or #FF3CB371.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MediumSlateBlue">
|
|
<summary>Gets the predefined color of medium slate blue, or #FF7B68EE.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MediumSpringGreen">
|
|
<summary>Gets the predefined color of medium spring green, or #FF00FA9A.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MediumTurquoise">
|
|
<summary>Gets the predefined color of medium turquoise, or #FF48D1CC.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MediumVioletRed">
|
|
<summary>Gets the predefined color of medium violet red, or #FFC71585.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MidnightBlue">
|
|
<summary>Gets the predefined color of midnight blue, or #FF191970.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MintCream">
|
|
<summary>Gets the predefined color of mint cream, or #FFF5FFFA.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.MistyRose">
|
|
<summary>Gets the predefined color of misty rose, or #FFFFE4E1.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Moccasin">
|
|
<summary>Gets the predefined color of moccasin, or #FFFFE4B5.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.NavajoWhite">
|
|
<summary>Gets the predefined color of navajo white, or #FFFFDEAD.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Navy">
|
|
<summary>Gets the predefined color of navy, or #FF000080.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.OldLace">
|
|
<summary>Gets the predefined color of old lace, or #FFFDF5E6.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Olive">
|
|
<summary>Gets the predefined color of olive, or #FF808000.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.OliveDrab">
|
|
<summary>Gets the predefined color of olive drab, or #FF6B8E23.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Orange">
|
|
<summary>Gets the predefined color of orange, or #FFFFA500.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.OrangeRed">
|
|
<summary>Gets the predefined color of orange red, or #FFFF4500.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Orchid">
|
|
<summary>Gets the predefined color of orchid, or #FFDA70D6.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.PaleGoldenrod">
|
|
<summary>Gets the predefined color of pale goldenrod, or #FFEEE8AA.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.PaleGreen">
|
|
<summary>Gets the predefined color of pale green, or #FF98FB98.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.PaleTurquoise">
|
|
<summary>Gets the predefined color of pale turquoise, or #FFAFEEEE.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.PaleVioletRed">
|
|
<summary>Gets the predefined color of pale violet red, or #FFDB7093.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.PapayaWhip">
|
|
<summary>Gets the predefined color of papaya whip, or #FFFFEFD5.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.PeachPuff">
|
|
<summary>Gets the predefined color of peach puff, or #FFFFDAB9.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Peru">
|
|
<summary>Gets the predefined color of peru, or #FFCD853F.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Pink">
|
|
<summary>Gets the predefined color of pink, or #FFFFC0CB.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Plum">
|
|
<summary>Gets the predefined color of plum, or #FFDDA0DD.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.PowderBlue">
|
|
<summary>Gets the predefined color of powder blue, or #FFB0E0E6.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Purple">
|
|
<summary>Gets the predefined color of purple, or #FF800080.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Red">
|
|
<summary>Gets the predefined color of red, or #FFFF0000.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.RosyBrown">
|
|
<summary>Gets the predefined color of rosy brown, or #FFBC8F8F.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.RoyalBlue">
|
|
<summary>Gets the predefined color of royal blue, or #FF4169E1.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.SaddleBrown">
|
|
<summary>Gets the predefined color of saddle brown, or #FF8B4513.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Salmon">
|
|
<summary>Gets the predefined color of salmon, or #FFFA8072.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.SandyBrown">
|
|
<summary>Gets the predefined color of sandy brown, or #FFF4A460.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.SeaGreen">
|
|
<summary>Gets the predefined color of sea green, or #FF2E8B57.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.SeaShell">
|
|
<summary>Gets the predefined color of sea shell, or #FFFFF5EE.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Sienna">
|
|
<summary>Gets the predefined color of sienna, or #FFA0522D.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Silver">
|
|
<summary>Gets the predefined color of silver, or #FFC0C0C0.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.SkyBlue">
|
|
<summary>Gets the predefined color of sky blue, or #FF87CEEB.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.SlateBlue">
|
|
<summary>Gets the predefined color of slate blue, or #FF6A5ACD.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.SlateGray">
|
|
<summary>Gets the predefined color of slate gray, or #FF708090.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Snow">
|
|
<summary>Gets the predefined color of snow, or #FFFFFAFA.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.SpringGreen">
|
|
<summary>Gets the predefined color of spring green, or #FF00FF7F.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.SteelBlue">
|
|
<summary>Gets the predefined color of steel blue, or #FF4682B4.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Tan">
|
|
<summary>Gets the predefined color of tan, or #FFD2B48C.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Teal">
|
|
<summary>Gets the predefined color of teal, or #FF008080.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Thistle">
|
|
<summary>Gets the predefined color of thistle, or #FFD8BFD8.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Tomato">
|
|
<summary>Gets the predefined color of tomato, or #FFFF6347.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Transparent">
|
|
<summary>Gets the predefined color of white transparent, or #00FFFFFF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Turquoise">
|
|
<summary>Gets the predefined color of turquoise, or #FF40E0D0.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Violet">
|
|
<summary>Gets the predefined color of violet, or #FFEE82EE.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Wheat">
|
|
<summary>Gets the predefined color of wheat, or #FFF5DEB3.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.White">
|
|
<summary>Gets the predefined color of white, or #FFFFFFFF.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.WhiteSmoke">
|
|
<summary>Gets the predefined color of white smoke, or #FFF5F5F5.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.Yellow">
|
|
<summary>Gets the predefined color of yellow, or #FFFFFF00.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColors.YellowGreen">
|
|
<summary>Gets the predefined color of yellow green, or #FF9ACD32.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorSpace">
|
|
<summary>Represents a color space.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateIcc(SkiaSharp.SKColorSpaceIccProfile)">
|
|
<param name="profile">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateIcc(SkiaSharp.SKData)">
|
|
<param name="input">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateIcc(System.Byte[])">
|
|
<param name="input">The ICC profile data.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from an ICC profile.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateIcc(System.ReadOnlySpan{System.Byte})">
|
|
<param name="input">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateIcc(System.Byte[],System.Int64)">
|
|
<param name="input">The ICC profile data.</param>
|
|
<param name="length">The size of the data.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from an ICC profile.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateIcc(System.IntPtr,System.Int64)">
|
|
<param name="input">The ICC profile data.</param>
|
|
<param name="length">The size of the data.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from an ICC profile.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKColorSpaceRenderTargetGamma,SkiaSharp.SKColorSpaceGamut)">
|
|
<param name="gamma">The gamma transfer function.</param>
|
|
<param name="gamut">The color gamut.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a transfer function and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKColorSpaceRenderTargetGamma,SkiaSharp.SKMatrix44)">
|
|
<param name="gamma">The gamma transfer function.</param>
|
|
<param name="toXyzD50">The matrix transformation to XYZ D50.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a transfer function and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKColorSpaceTransferFn,SkiaSharp.SKColorSpaceGamut)">
|
|
<param name="coeffs">The coefficients for a common transfer function equation.</param>
|
|
<param name="gamut">The color gamut.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a transfer function and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKColorSpaceTransferFn,SkiaSharp.SKColorSpaceXyz)">
|
|
<param name="transferFn">To be added.</param>
|
|
<param name="toXyzD50">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKColorSpaceTransferFn,SkiaSharp.SKMatrix44)">
|
|
<param name="coeffs">The coefficients for a common transfer function equation.</param>
|
|
<param name="toXyzD50">The matrix transformation to XYZ D50.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a transfer function and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKNamedGamma,SkiaSharp.SKColorSpaceGamut)">
|
|
<param name="gamma">The gamma.</param>
|
|
<param name="gamut">The color gamut.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a named gamma and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKNamedGamma,SkiaSharp.SKMatrix44)">
|
|
<param name="gamma">The gamma.</param>
|
|
<param name="toXyzD50">The matrix transformation to XYZ D50.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a named gamma and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKColorSpaceRenderTargetGamma,SkiaSharp.SKColorSpaceGamut,SkiaSharp.SKColorSpaceFlags)">
|
|
<param name="gamma">The gamma transfer function.</param>
|
|
<param name="gamut">The color gamut.</param>
|
|
<param name="flags">The optional flags.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a transfer function and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKColorSpaceRenderTargetGamma,SkiaSharp.SKMatrix44,SkiaSharp.SKColorSpaceFlags)">
|
|
<param name="gamma">The gamma transfer function.</param>
|
|
<param name="toXyzD50">The matrix transformation to XYZ D50.</param>
|
|
<param name="flags">The optional flags.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a transfer function and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKColorSpaceTransferFn,SkiaSharp.SKColorSpaceGamut,SkiaSharp.SKColorSpaceFlags)">
|
|
<param name="coeffs">The coefficients for a common transfer function equation.</param>
|
|
<param name="gamut">The color gamut.</param>
|
|
<param name="flags">The optional flags.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a transfer function and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateRgb(SkiaSharp.SKColorSpaceTransferFn,SkiaSharp.SKMatrix44,SkiaSharp.SKColorSpaceFlags)">
|
|
<param name="coeffs">The coefficients for a common transfer function equation.</param>
|
|
<param name="toXyzD50">The matrix transformation to XYZ D50.</param>
|
|
<param name="flags">The optional flags.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> from a transfer function and a color gamut.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateSrgb">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> that represents the sRGB color space.</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.CreateSrgbLinear">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpace" /> with the sRGB primaries, but a linear (1.0) gamma</summary>
|
|
<returns>Returns the new instance of <see cref="T:SkiaSharp.SKColorSpace" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKColorSpace" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKColorSpace" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.Equal(SkiaSharp.SKColorSpace,SkiaSharp.SKColorSpace)">
|
|
<param name="left">The first color space.</param>
|
|
<param name="right">The second color space.</param>
|
|
<summary>Compare two color spaces to determine if they are equivalent.</summary>
|
|
<returns>Returns <see langword="true" /> if both color spaces are equivalent, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.FromXyzD50">
|
|
<summary>Describes color space gamut as a transformation from XYZ D50.</summary>
|
|
<returns>Returns the matrix if the color gamut can be described as a matrix, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpace.GammaIsCloseToSrgb">
|
|
<summary>Gets a value indicating whether or not the color space gamma is near enough to be approximated as sRGB.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpace.GammaIsLinear">
|
|
<summary>Gets a value indicating whether or not the color space gamma is linear.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.GetNumericalTransferFunction">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.GetNumericalTransferFunction(SkiaSharp.SKColorSpaceTransferFn@)">
|
|
<param name="fn">The values of the coefficients to the standard equation.</param>
|
|
<summary>Returns the values of the coefficients to the standard equation.</summary>
|
|
<returns>Returns <see langword="true" /> if transfer function can be represented as coefficients to the standard equation, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpace.IsNumericalTransferFunction">
|
|
<summary>Gets a value indicating whether the transfer function can be represented as coefficients to the standard equation.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpace.IsSrgb">
|
|
<summary>Gets a value indicating whether or not the color space is sRGB.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpace.NamedGamma">
|
|
<summary>Gets the gamma of the color space.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.ToColorSpaceXyz">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.ToColorSpaceXyz(SkiaSharp.SKColorSpaceXyz@)">
|
|
<param name="toXyzD50">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.ToLinearGamma">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.ToProfile">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.ToSrgbGamma">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.ToXyzD50">
|
|
<summary>Describes color space gamut as a transformation to XYZ D50.</summary>
|
|
<returns>Returns the matrix if the color gamut can be described as a matrix, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpace.ToXyzD50(SkiaSharp.SKMatrix44)">
|
|
<param name="toXyzD50">The matrix that describes the color space.</param>
|
|
<summary>Converts the color space to a XYZ D50 matrix that describes the color space.</summary>
|
|
<returns>Returns <see langword="true" /> if the color gamut can be described as a matrix, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpace.Type">
|
|
<summary>Gets the color space type.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorSpaceFlags">
|
|
<summary>Various flags that are used when creating a <see cref="T:SkiaSharp.SKColorSpace" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceFlags.None">
|
|
<summary>Default construction.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceFlags.NonLinearBlending">
|
|
<summary>Blending is non-linear.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorSpaceGamut">
|
|
<summary>Various gamut values for use with a <see cref="T:SkiaSharp.SKColorSpace" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceGamut.AdobeRgb">
|
|
<summary>Adobe RGB.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceGamut.Dcip3D65">
|
|
<summary>DCI-P3 D65.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceGamut.Rec2020">
|
|
<summary>Rec. 2020 (ITU-R Recommendation BT.2020).</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceGamut.Srgb">
|
|
<summary>sRGB.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorSpaceIccProfile">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorSpaceIccProfile">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceIccProfile.Buffer">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceIccProfile.Create(SkiaSharp.SKData)">
|
|
<param name="data">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceIccProfile.Create(System.Byte[])">
|
|
<param name="data">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceIccProfile.Create(System.ReadOnlySpan{System.Byte})">
|
|
<param name="data">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceIccProfile.Create(System.IntPtr,System.Int64)">
|
|
<param name="data">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceIccProfile.DisposeNative">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceIccProfile.Size">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceIccProfile.ToColorSpaceXyz">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceIccProfile.ToColorSpaceXyz(SkiaSharp.SKColorSpaceXyz@)">
|
|
<param name="toXyzD50">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorSpacePrimaries">
|
|
<summary>Describes a color gamut with primaries and a white point.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorSpacePrimaries(System.Single[])">
|
|
<param name="values">The values of the primaries and white point.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKColorSpacePrimaries" /> instance.</summary>
|
|
<remarks>There must be exactly 8 values in the array with the form [RX, RY, GX, GY, BX, BY, WX, WY].</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorSpacePrimaries(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="rx">The red X-coordinate.</param>
|
|
<param name="ry">The red Y-coordinate.</param>
|
|
<param name="gx">The green X-coordinate.</param>
|
|
<param name="gy">The green Y-coordinate.</param>
|
|
<param name="bx">The blue X-coordinate.</param>
|
|
<param name="by">The blue Y-coordinate.</param>
|
|
<param name="wx">The white X-coordinate.</param>
|
|
<param name="wy">The white Y-coordinate.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKColorSpacePrimaries" /> instance.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpacePrimaries.BX">
|
|
<summary>Gets or sets the blue X-coordinate.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpacePrimaries.BY">
|
|
<summary>Gets or sets the blue Y-coordinate.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpacePrimaries.Empty">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpacePrimaries.Equals(SkiaSharp.SKColorSpacePrimaries)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpacePrimaries.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpacePrimaries.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpacePrimaries.GX">
|
|
<summary>Gets or sets the green X-coordinate.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpacePrimaries.GY">
|
|
<summary>Gets or sets the green Y-coordinate.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpacePrimaries.op_Equality(SkiaSharp.SKColorSpacePrimaries,SkiaSharp.SKColorSpacePrimaries)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpacePrimaries.op_Inequality(SkiaSharp.SKColorSpacePrimaries,SkiaSharp.SKColorSpacePrimaries)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpacePrimaries.RX">
|
|
<summary>Gets or sets the red X-coordinate.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpacePrimaries.RY">
|
|
<summary>Gets or sets the red Y-coordinate.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpacePrimaries.ToColorSpaceXyz">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpacePrimaries.ToColorSpaceXyz(SkiaSharp.SKColorSpaceXyz@)">
|
|
<param name="toXyzD50">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpacePrimaries.ToXyzD50">
|
|
<summary>Converts primaries and a white point to a XYZ D50 matrix, the preferred color gamut representation of <see cref="T:SkiaSharp.SKColorSpace" />.</summary>
|
|
<returns>Returns the XYZ D50 matrix, or <see langword="null" /> if the conversion is not possible.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpacePrimaries.ToXyzD50(SkiaSharp.SKMatrix44)">
|
|
<param name="toXyzD50">The XYZ D50 matrix.</param>
|
|
<summary>Converts primaries and a white point to a XYZ D50 matrix, the preferred color gamut representation of <see cref="T:SkiaSharp.SKColorSpace" />.</summary>
|
|
<returns>Returns <see langword="true" /> if the conversion succeeded, otherwise <see langword="false" /> if the conversion is not possible.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpacePrimaries.Values">
|
|
<summary>Gets the values of the primaries and white as an array with the form [RX, RY, GX, GY, BX, BY, WX, WY].</summary>
|
|
<value />
|
|
<remarks>]</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpacePrimaries.WX">
|
|
<summary>Gets or sets the white X-coordinate.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpacePrimaries.WY">
|
|
<summary>Gets or sets the white Y-coordinate.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorSpaceRenderTargetGamma">
|
|
<summary>Represents gamma transfer functions.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceRenderTargetGamma.Linear">
|
|
<summary>The transfer function is linear.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceRenderTargetGamma.Srgb">
|
|
<summary>The transfer function is the canonical sRGB curve, which has a short linear segment followed by a 2.4f exponential.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorSpaceTransferFn">
|
|
<summary>Represents the coefficients for a common transfer function equation.</summary>
|
|
<remarks>
|
|
<para>The coefficients are specified as a transformation from a curved space to linear. </para>
|
|
<para />
|
|
<para>LinearVal = C*InputVal + F; (for 0.0f <= InputVal < D)</para>
|
|
<para>LinearVal = (A*InputVal + B)^G + E; (for D <= InputVal <= 1.0f)</para>
|
|
<para />
|
|
<para>Function is undefined if InputVal is not in [ 0.0f, 1.0f ].</para>
|
|
<para>Resulting LinearVals must be in [ 0.0f, 1.0f ].</para>
|
|
<para>Function must be positive and increasing.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorSpaceTransferFn(System.Single[])">
|
|
<param name="values">The values of the coefficients.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpaceTransferFn" />.</summary>
|
|
<remarks>There must be exactly 7 values in the array with the form [G, A, B, C, D, E, F].</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorSpaceTransferFn(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="g">The G coefficient.</param>
|
|
<param name="a">The A coefficient.</param>
|
|
<param name="b">The B coefficient.</param>
|
|
<param name="c">The C coefficient.</param>
|
|
<param name="d">The D coefficient.</param>
|
|
<param name="e">The E coefficient.</param>
|
|
<param name="f">The F coefficient.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKColorSpaceTransferFn" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.A">
|
|
<summary>Gets or sets the A coefficient.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.B">
|
|
<summary>Gets or sets the B coefficient.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.C">
|
|
<summary>Gets or sets the C coefficient.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.D">
|
|
<summary>Gets or sets the D coefficient.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.E">
|
|
<summary>Gets or sets the E coefficient.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceTransferFn.Empty">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceTransferFn.Equals(SkiaSharp.SKColorSpaceTransferFn)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceTransferFn.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.F">
|
|
<summary>Gets or sets the F coefficient.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.G">
|
|
<summary>Gets or sets the G coefficient.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceTransferFn.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.Hlg">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceTransferFn.Invert">
|
|
<summary>Inverts coefficients for a common transfer function equation.</summary>
|
|
<returns>Returns the mathematically inverted parametric transfer function equation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.Linear">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceTransferFn.op_Equality(SkiaSharp.SKColorSpaceTransferFn,SkiaSharp.SKColorSpaceTransferFn)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceTransferFn.op_Inequality(SkiaSharp.SKColorSpaceTransferFn,SkiaSharp.SKColorSpaceTransferFn)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.Pq">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.Rec2020">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.Srgb">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceTransferFn.Transform(System.Single)">
|
|
<param name="x">The input to transform.</param>
|
|
<summary>Transform a single input by this transfer function.</summary>
|
|
<returns>Returns the transformed input.</returns>
|
|
<remarks>For negative inputs, returns `-Transform(Math.Abs(x))`.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.TwoDotTwo">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceTransferFn.Values">
|
|
<summary>Gets the coefficients as an array with the form [G, A, B, C, D, E, F].</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorSpaceType">
|
|
<summary>The various types of color sapces.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceType.Cmyk">
|
|
<summary>The CMYK color space.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceType.Gray">
|
|
<summary>The gray color space.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceType.Rgb">
|
|
<summary>The RGB color space.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorSpaceXyz">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorSpaceXyz(System.Single)">
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorSpaceXyz(System.Single[])">
|
|
<param name="values">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorSpaceXyz(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="m00">To be added.</param>
|
|
<param name="m01">To be added.</param>
|
|
<param name="m02">To be added.</param>
|
|
<param name="m10">To be added.</param>
|
|
<param name="m11">To be added.</param>
|
|
<param name="m12">To be added.</param>
|
|
<param name="m20">To be added.</param>
|
|
<param name="m21">To be added.</param>
|
|
<param name="m22">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceXyz.AdobeRgb">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceXyz.Concat(SkiaSharp.SKColorSpaceXyz,SkiaSharp.SKColorSpaceXyz)">
|
|
<param name="a">To be added.</param>
|
|
<param name="b">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceXyz.Dcip3">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceXyz.DisplayP3">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorSpaceXyz.Empty">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceXyz.Equals(SkiaSharp.SKColorSpaceXyz)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceXyz.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceXyz.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceXyz.Invert">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceXyz.Item(System.Int32,System.Int32)">
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceXyz.op_Equality(SkiaSharp.SKColorSpaceXyz,SkiaSharp.SKColorSpaceXyz)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorSpaceXyz.op_Inequality(SkiaSharp.SKColorSpaceXyz,SkiaSharp.SKColorSpaceXyz)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceXyz.Rec2020">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceXyz.Srgb">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceXyz.Values">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorSpaceXyz.Xyz">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorTable">
|
|
<summary>Holds a premultiplied color table for indexed 8-bit bitmaps.</summary>
|
|
<remarks>This class is used to represent a color lookup table for indexed bitmap images. The table can contain up to <see cref="F:SkiaSharp.SKColorTable.MaxLength" /> (256) colors (8 bits). The colors are stored are premultiplied 32-bit colors.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorTable">
|
|
<summary>Creates a new, empty color table with 256 empty elements.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorTable(SkiaSharp.SKColor[])">
|
|
<param name="colors">The unpremultiplied colors to initialize with.</param>
|
|
<summary>Creates a color table with the provided unpremultiplied colors, up to <see cref="F:SkiaSharp.SKColorTable.MaxLength" /> (256) colors can be provided.</summary>
|
|
<remarks>The colors will be automatically premultiplied.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorTable(SkiaSharp.SKPMColor[])">
|
|
<param name="colors">The premultiplied colors to initialize with.</param>
|
|
<summary>Creates a color table with the provided premultiplied colors, up to <see cref="F:SkiaSharp.SKColorTable.MaxLength" /> (256) colors can be provided.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorTable(System.Int32)">
|
|
<param name="count">The number of empty colors to initialize with.</param>
|
|
<summary>Creates a color table with the specified number of elements, with empty colors.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorTable(SkiaSharp.SKColor[],System.Int32)">
|
|
<param name="colors">The unpremultiplied colors to initialize with.</param>
|
|
<param name="count">The number of colors to initialize with.</param>
|
|
<summary>Creates a color table with the provided unpremultiplied colors, but only consumes the first count elements from the colors array.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKColorTable(SkiaSharp.SKPMColor[],System.Int32)">
|
|
<param name="colors">The premultiplied colors to initialize with.</param>
|
|
<param name="count">The number of colors to initialize with.</param>
|
|
<summary>Creates a color table with the provided premultiplied colors, but only consumes the first count elements from the colors array.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorTable.Colors">
|
|
<summary>Gets a copy of the premultiplied colors in the color table.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorTable.Count">
|
|
<summary>Gets the number of colors in the lookup table.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorTable.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKColorTable" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKColorTable" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorTable.GetUnPreMultipliedColor(System.Int32)">
|
|
<param name="index">The index of the color to get.</param>
|
|
<summary>Returns the unpremultiplied color at the specified index.</summary>
|
|
<returns>Returns the unpremultiplied color.</returns>
|
|
<remarks>This is equivalent to premultiplying the value from <see cref="P:SkiaSharp.SKColorTable.Item(System.Int32)" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorTable.Item(System.Int32)">
|
|
<param name="index" />
|
|
<summary>Gets the premultiplied color at the specified index.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorTable.MaxLength">
|
|
<summary>Gets the maximum number of colors in the color lookup table.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKColorTable.ReadColors">
|
|
<summary>Returns an unmanaged pointer to the color lookup table.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKColorTable.UnPreMultipledColors">
|
|
<summary>Gets a copy of the unpremultiplied colors in the color table.</summary>
|
|
<value />
|
|
<remarks>The is equivalent to premultiplying the value of <see cref="P:SkiaSharp.SKColorTable.Colors" />.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKColorType">
|
|
<summary>Describes how to interpret the components of a pixel.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Alpha16">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Alpha8">
|
|
<summary>Represents a 8-bit alpha-only color.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.AlphaF16">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Argb4444">
|
|
<summary>Represents a 16-bit color with the format ARGB.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Bgr101010x">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Bgra1010102">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Bgra8888">
|
|
<summary>Represents a 32-bit color with the format BGRA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Gray8">
|
|
<summary>Represents an opaque 8-bit grayscale color.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Index8">
|
|
<summary>Represents a 8-bit indexed color.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Rg1616">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Rg88">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Rgb101010x">
|
|
<summary>Represents an opaque 32-bit color with the format RGB, with 10 bits per color component.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Rgb565">
|
|
<summary>Represents an opaque 16-bit color with the format RGB, with the red and blue components being 5 bits and the green component being 6 bits.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Rgb888x">
|
|
<summary>Represents an opaque 32-bit color with the format RGB, with 8 bits per color component.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Rgba1010102">
|
|
<summary>Represents a 32-bit color with the format RGBA, with 10 bits per color component and 2 bits for the alpha component.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Rgba16161616">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Rgba8888">
|
|
<summary>Represents a 32-bit color with the format RGBA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.RgbaF16">
|
|
<summary>Represents a floating-point based color with the format RGBA.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.RgbaF16Clamped">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.RgbaF32">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.RgF16">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKColorType.Unknown">
|
|
<summary>Unknown encoding.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKCropRectFlags">
|
|
<summary>Flags used by the <see cref="T:SkiaSharp.SKImageFilter.CropRect" /> method.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCropRectFlags.HasAll">
|
|
<summary>Consume all edges of the rectangle.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCropRectFlags.HasHeight">
|
|
<summary>Only use the height component of the rectangle.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCropRectFlags.HasLeft">
|
|
<summary>Only use the left component of the rectangle.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCropRectFlags.HasNone">
|
|
<summary>None of the edges have been specified.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCropRectFlags.HasTop">
|
|
<summary>Only use the top component of the rectangle.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKCropRectFlags.HasWidth">
|
|
<summary>Only use the width component of the rectangle.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKData">
|
|
<summary>The <see cref="T:SkiaSharp.SKData" /> holds an immutable data buffer.</summary>
|
|
<remarks>
|
|
<para>Not only is the data immutable, but the actual pointer that is returned by the <see cref="P:SkiaSharp.SKData.Data" /> property is guaranteed to always be the same for the life of this instance.</para>
|
|
<para>The <see cref="M:SkiaSharp.SKData.AsStream" /> method can be used to return a <see cref="T:System.IO.Stream" /> that wraps this <see cref="T:SkiaSharp.SKData" /> and allows for .NET APIs to scan the contents of the <see cref="T:SkiaSharp.SKData" /> as a stream.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.AsSpan">
|
|
<summary>Returns a span that wraps the underlying data.</summary>
|
|
<returns>Returns the data as a span.</returns>
|
|
<remarks>This span is only valid as long as the data is valid.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.AsStream">
|
|
<summary>Wraps the <see cref="T:SkiaSharp.SKData" /> as a <see cref="T:System.IO.Stream" />.</summary>
|
|
<returns>Returns the new <see cref="T:System.IO.Stream" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.AsStream(System.Boolean)">
|
|
<param name="streamDisposesData">Whether or not to dispose the data object when the stream is disposed.</param>
|
|
<summary>Wraps the <see cref="T:SkiaSharp.SKData" /> as a <see cref="T:System.IO.Stream" />.</summary>
|
|
<returns>Returns the new <see cref="T:System.IO.Stream" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(SkiaSharp.SKStream)">
|
|
<param name="stream">The stream to read.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data from the stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.Int32)">
|
|
<param name="size">The size of the data buffer to create.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with uninitialized data.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.Int64)">
|
|
<param name="size">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.IO.Stream)">
|
|
<param name="stream">The stream to read.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data from the stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.String)">
|
|
<param name="filename">The file to open.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with the data from the file.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.UInt64)">
|
|
<param name="size">The size of the data buffer to create.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with uninitialized data.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(SkiaSharp.SKStream,System.Int32)">
|
|
<param name="stream">The stream to read.</param>
|
|
<param name="length">The amount of data to read.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data from the stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(SkiaSharp.SKStream,System.Int64)">
|
|
<param name="stream">The stream to read.</param>
|
|
<param name="length">The amount of data to read.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data from the stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(SkiaSharp.SKStream,System.UInt64)">
|
|
<param name="stream">The stream to read.</param>
|
|
<param name="length">The amount of data to read.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data from the stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.IntPtr,System.Int32)">
|
|
<param name="address">The pointer to a buffer.</param>
|
|
<param name="length">The length of the buffer.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with reference to the specified data.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance with reference to the specified data.</returns>
|
|
<remarks>The caller is responsible for ensuring the data buffer lives as long as the <see cref="T:SkiaSharp.SKData" /> instance.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.IO.Stream,System.Int32)">
|
|
<param name="stream">The stream to read.</param>
|
|
<param name="length">The amount of data to read.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data from the stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.IO.Stream,System.Int64)">
|
|
<param name="stream">The stream to read.</param>
|
|
<param name="length">The amount of data to read.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data from the stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.IO.Stream,System.UInt64)">
|
|
<param name="stream">The stream to read.</param>
|
|
<param name="length">The amount of data to read.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data from the stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.IntPtr,System.Int32,SkiaSharp.SKDataReleaseDelegate)">
|
|
<param name="address">The pointer to a buffer.</param>
|
|
<param name="length">The length of the buffer.</param>
|
|
<param name="releaseProc">The delegate to invoke when the <see cref="T:SkiaSharp.SKData" /> instance is ready to be discarded.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with reference to the specified data.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance with reference to the specified data.</returns>
|
|
<remarks>The caller is responsible for ensuring the data buffer lives as long as the <see cref="T:SkiaSharp.SKData" /> instance.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Create(System.IntPtr,System.Int32,SkiaSharp.SKDataReleaseDelegate,System.Object)">
|
|
<param name="address">The pointer to a buffer.</param>
|
|
<param name="length">The length of the buffer.</param>
|
|
<param name="releaseProc">The delegate to invoke when the <see cref="T:SkiaSharp.SKData" /> instance is ready to be discarded.</param>
|
|
<param name="context">The user state to pass to the delegate when it is invoked.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with reference to the specified data.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance with reference to the specified data.</returns>
|
|
<remarks>The caller is responsible for ensuring the data buffer lives as long as the <see cref="T:SkiaSharp.SKData" /> instance.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.CreateCopy(System.Byte[])">
|
|
<param name="bytes">The array of bytes that will be copied.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the provided byte array.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.CreateCopy(System.ReadOnlySpan{System.Byte})">
|
|
<param name="bytes">The span of bytes that will be copied.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the provided byte span.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.CreateCopy(System.Byte[],System.UInt64)">
|
|
<param name="bytes">The array of bytes that will be copied.</param>
|
|
<param name="length">The size of the buffer to create.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the provided byte array.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.CreateCopy(System.IntPtr,System.Int32)">
|
|
<param name="bytes">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.CreateCopy(System.IntPtr,System.Int64)">
|
|
<param name="bytes">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.CreateCopy(System.IntPtr,System.UInt64)">
|
|
<param name="bytes">The pointer to a buffer.</param>
|
|
<param name="length">The length of the buffer.</param>
|
|
<summary>Returns a new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the provided byte buffer.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKData" /> instance with a copy of the data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKData.Data">
|
|
<summary>Gets a pointer to the data wrapped by this <see cref="T:SkiaSharp.SKData" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Dispose(System.Boolean)">
|
|
<param name="disposing">Specify true to release both managed and unmanaged resources, false to release only unmanaged resources.</param>
|
|
<summary>Releases the resources associated with the data. If this <see cref="T:SkiaSharp.SKData" /> was created with one of the <see cref="M:SkiaSharp.SKData.FromMallocMemory(System.IntPtr,System.UInt64)" /> methods, then the operating system's "free" method will be called on the data.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKData.Empty">
|
|
<summary>Gets a reference to the empty data instance.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKData.IsEmpty">
|
|
<summary>Gets a value indicating whether or not the data is empty.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.SaveTo(System.IO.Stream)">
|
|
<param name="target">The stream to save the data into.</param>
|
|
<summary>Saves the buffer into the provided stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKData.Size">
|
|
<summary>Gets the size of this data object in bytes.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKData.Span">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.Subset(System.UInt64,System.UInt64)">
|
|
<param name="offset">The offset of the data.</param>
|
|
<param name="length">The length for the new <see cref="T:SkiaSharp.SKData" />.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKData" /> that points to a slice in this <see cref="T:SkiaSharp.SKData" />.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKData.ToArray">
|
|
<summary>Copies the data object into a byte array.</summary>
|
|
<returns>Returns the byte array of the data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKDataReleaseDelegate">
|
|
<param name="address">The pointer to the byte buffer.</param>
|
|
<param name="context">The user state passed to <see cref="M:SkiaSharp.SKData.Create(System.IntPtr,System.Int32,SkiaSharp.SKDataReleaseDelegate,System.Object)" />.</param>
|
|
<summary>The delegate that is used when a <see cref="T:SkiaSharp.SKData" /> instance is about to be released.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKDisplacementMapEffectChannelSelectorType">
|
|
<summary>Channel selector type for the <see cref="M:SkiaSharp.SKImageFilter.CreateDisplacementMapEffect(SkiaSharp.SKDisplacementMapEffectChannelSelectorType,SkiaSharp.SKDisplacementMapEffectChannelSelectorType,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter.CropRect)" /> method.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDisplacementMapEffectChannelSelectorType.A">
|
|
<summary>The alpha channel.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDisplacementMapEffectChannelSelectorType.B">
|
|
<summary>The blue channel.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDisplacementMapEffectChannelSelectorType.G">
|
|
<summary>The green channel.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDisplacementMapEffectChannelSelectorType.R">
|
|
<summary>The red channel.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDisplacementMapEffectChannelSelectorType.Unknown">
|
|
<summary>The channel is not known.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKDocument">
|
|
<summary>A high-level API for creating a document-based canvas.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
For each page, call <xref:SkiaSharp.SKDocument.BeginPage%2A> to get the
|
|
canvas, and then complete the page with a call to
|
|
<xref:SkiaSharp.SKDocument.EndPage%2A>. Finally, call
|
|
<xref:SkiaSharp.SKDocument.Close%2A> to complete the document.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.Abort">
|
|
<summary>Stops producing the document immediately.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.BeginPage(System.Single,System.Single)">
|
|
<param name="width">The width of the page.</param>
|
|
<param name="height">The height of the page.</param>
|
|
<summary>Begins a new page for the document, returning the canvas that will draw into the page.</summary>
|
|
<returns>Returns a canvas for the new page.</returns>
|
|
<remarks>The document owns this canvas, and it will go out of scope when <see cref="M:SkiaSharp.SKDocument.EndPage" /> or <see cref="M:SkiaSharp.SKDocument.Close" /> is called, or the document is deleted.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.BeginPage(System.Single,System.Single,SkiaSharp.SKRect)">
|
|
<param name="width">The width of the page.</param>
|
|
<param name="height">The height of the page.</param>
|
|
<param name="content">The area for the page contents.</param>
|
|
<summary>Begins a new page for the document, returning the canvas that will draw into the page.</summary>
|
|
<returns>Returns a canvas for the new page.</returns>
|
|
<remarks>The document owns this canvas, and it will go out of scope when <see cref="M:SkiaSharp.SKDocument.EndPage" /> or <see cref="M:SkiaSharp.SKDocument.Close" /> is called, or the document is deleted.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.Close">
|
|
<summary>Closes the current file or stream holding the document's contents.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(SkiaSharp.SKWStream)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<summary>Create a PDF-backed document, writing the results into a stream.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(System.IO.Stream)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<summary>Create a PDF-backed document, writing the results into a stream.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(System.String)">
|
|
<param name="path">The path of the file to write to.</param>
|
|
<summary>Create a PDF-backed document, writing the results into a file.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(SkiaSharp.SKWStream,SkiaSharp.SKDocumentPdfMetadata)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<param name="metadata">The document metadata to include.</param>
|
|
<summary>Create a PDF-backed document, writing the results into a stream.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(SkiaSharp.SKWStream,System.Single)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<param name="dpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
|
|
<summary>Create a PDF-backed document, writing the results into a stream.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(System.IO.Stream,SkiaSharp.SKDocumentPdfMetadata)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<param name="metadata">The document metadata to include.</param>
|
|
<summary>Create a PDF-backed document with the specified metadata, writing the results into a stream.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(System.IO.Stream,System.Single)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<param name="dpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
|
|
<summary>Create a PDF-backed document, writing the results into a stream.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(System.String,SkiaSharp.SKDocumentPdfMetadata)">
|
|
<param name="path">The path of the file to write to.</param>
|
|
<param name="metadata">The document metadata to include.</param>
|
|
<summary>Create a PDF-backed document with the specified metadata, writing the results into a file.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(System.String,System.Single)">
|
|
<param name="path">The path of the file to write to.</param>
|
|
<param name="dpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
|
|
<summary>Create a PDF-backed document, writing the results into a file.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreatePdf(SkiaSharp.SKWStream,SkiaSharp.SKDocumentPdfMetadata,System.Single)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<param name="metadata">The document metadata to include.</param>
|
|
<param name="dpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
|
|
<summary>Create a PDF-backed document with the specified metadata, writing the results into a stream.</summary>
|
|
<returns>Returns the new PDF-backed document.</returns>
|
|
<remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreateXps(SkiaSharp.SKWStream)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<summary>Create a XPS-backed document, writing the results into a stream.</summary>
|
|
<returns>Returns the new XPS-backed document.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreateXps(System.IO.Stream)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<summary>Create a XPS-backed document, writing the results into a stream.</summary>
|
|
<returns>Returns the new XPS-backed document.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreateXps(System.String)">
|
|
<param name="path">The path of the file to write to.</param>
|
|
<summary>Create a XPS-backed document, writing the results into a file.</summary>
|
|
<returns>Returns the new XPS-backed document.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreateXps(SkiaSharp.SKWStream,System.Single)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<param name="dpi">The DPI (pixels-per-inch) at which features without native XPS support will be rasterized.</param>
|
|
<summary>Create a XPS-backed document, writing the results into a stream.</summary>
|
|
<returns>Returns the new XPS-backed document.</returns>
|
|
<remarks>XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreateXps(System.IO.Stream,System.Single)">
|
|
<param name="stream">The stream to write to.</param>
|
|
<param name="dpi">The DPI (pixels-per-inch) at which features without native XPS support will be rasterized.</param>
|
|
<summary>Create a XPS-backed document, writing the results into a stream.</summary>
|
|
<returns>Returns the new XPS-backed document.</returns>
|
|
<remarks>XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.CreateXps(System.String,System.Single)">
|
|
<param name="path">The path of the file to write to.</param>
|
|
<param name="dpi">The DPI (pixels-per-inch) at which features without native XPS support will be rasterized.</param>
|
|
<summary>Create a XPS-backed document, writing the results into a file.</summary>
|
|
<returns>Returns the new XPS-backed document.</returns>
|
|
<remarks>XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDocument.DefaultRasterDpi">
|
|
<summary>Gets the default DPI for raster graphics.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKDocument" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKDocument" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocument.EndPage">
|
|
<summary>Completes the drawing for the current page created by <see cref="M:SkiaSharp.SKDocument.BeginPage(System.Single,System.Single)" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKDocumentPdfMetadata">
|
|
<summary>Optional metadata to be passed into the PDF factory function.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKDocumentPdfMetadata(System.Int32)">
|
|
<param name="encodingQuality">The encoding quality.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKDocumentPdfMetadata" /> with the specified encoding quality.</summary>
|
|
<remarks>The encoding quality is between 0 and 100. A quality of 101 indicates lossless encoding.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKDocumentPdfMetadata(System.Single)">
|
|
<param name="rasterDpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKDocumentPdfMetadata" /> with the specified raster DPI.</summary>
|
|
<remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKDocumentPdfMetadata(System.Single,System.Int32)">
|
|
<param name="rasterDpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
|
|
<param name="encodingQuality">The encoding quality.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKDocumentPdfMetadata" /> with the specified raster DPI and encoding quality.</summary>
|
|
<remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. The encoding quality is between 0 and 100. A quality of 101 indicates lossless encoding.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.Author">
|
|
<summary>The name of the person who created the document.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.Creation">
|
|
<summary>The date and time the document was created.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.Creator">
|
|
<summary>The name of the product that created the original document, if the document was converted to PDF from another format.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDocumentPdfMetadata.Default">
|
|
<summary>Gets a new instance of <see cref="T:SkiaSharp.SKDocumentPdfMetadata" /> with the values set to the defaults.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDocumentPdfMetadata.DefaultEncodingQuality">
|
|
<summary>Gets the default encoding quality (101% or lossless).</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDocumentPdfMetadata.DefaultRasterDpi">
|
|
<summary>Gets the default DPI (72.0 DPI).</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.EncodingQuality">
|
|
<summary>Gets or sets the encoding quality.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Encoding quality controls the trade-off between size and quality. By default
|
|
this is set to 101 percent, which corresponds to lossless encoding. If this
|
|
value is set to a value <= 100, and the image is opaque, it will be encoded
|
|
(using JPEG) with that quality setting.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocumentPdfMetadata.Equals(SkiaSharp.SKDocumentPdfMetadata)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocumentPdfMetadata.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocumentPdfMetadata.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.Keywords">
|
|
<summary>Comma-separated keywords associated with the document.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.Modified">
|
|
<summary>The date and time the document was most recently modified.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocumentPdfMetadata.op_Equality(SkiaSharp.SKDocumentPdfMetadata,SkiaSharp.SKDocumentPdfMetadata)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDocumentPdfMetadata.op_Inequality(SkiaSharp.SKDocumentPdfMetadata,SkiaSharp.SKDocumentPdfMetadata)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.PdfA">
|
|
<summary>Gets or sets a value indicating whether or not make the document PDF/A-2b conformant.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If true, include XMP metadata, a document UUID, and sRGB output intent
|
|
information. This adds length to the document and makes it non-reproducable,
|
|
but are necessary features for PDF/A-2b conformance.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.Producer">
|
|
<summary>The product that is converting this document to PDF.</summary>
|
|
<value />
|
|
<remarks>Leave empty to get the default, correct value.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.RasterDpi">
|
|
<summary>Gets or sets the DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.
|
|
|
|
A larger DPI would create a PDF that reflects the original intent with better
|
|
fidelity, but it can make for larger PDF files too, which would use more
|
|
memory while rendering, and it would be slower to be processed or sent online
|
|
or to printer.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.Subject">
|
|
<summary>The subject of the document.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDocumentPdfMetadata.Title">
|
|
<summary>The document's title.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKDrawable">
|
|
<summary>Represents the base class for objects that draw into <see cref="T:SkiaSharp.SKCanvas" />.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The object has a generation ID, which is guaranteed to be unique across all
|
|
drawables. To allow for clients of the drawable that may want to cache the
|
|
results, the drawable must change its generation ID whenever its internal
|
|
state changes such that it will draw differently.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKDrawable">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKDrawable" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKDrawable(System.Boolean)">
|
|
<param name="owns">The value indicating whether this object should destroy the underlying native object.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKDrawable" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDrawable.Bounds">
|
|
<summary>Gets the conservative bounds of what the drawable will draw.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If the drawable can change what it draws (e.g. animation or in response to
|
|
some external change), then this must return a bounds that is always valid for
|
|
all possible states.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDrawable.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKDrawable" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKDrawable" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDrawable.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDrawable.Draw(SkiaSharp.SKCanvas,SkiaSharp.SKMatrix@)">
|
|
<param name="canvas">The canvas to draw on.</param>
|
|
<param name="matrix">The matrix to use when drawing.</param>
|
|
<summary>Draw the current drawable onto the specified canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDrawable.Draw(SkiaSharp.SKCanvas,System.Single,System.Single)">
|
|
<param name="canvas">The canvas to draw on.</param>
|
|
<param name="x">The amount to translate along the x-coordinate.</param>
|
|
<param name="y">The amount to translate along the y-coordinate.</param>
|
|
<summary>Draw the current drawable onto the specified canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKDrawable.GenerationId">
|
|
<summary>Gets the unique value for this instance.</summary>
|
|
<value />
|
|
<remarks>It is presumed that if two calls return the same value, then drawing this will result in the same image as well.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDrawable.NotifyDrawingChanged">
|
|
<summary>Invalidate the drawing generation ID, indicating that the drawing has changed.</summary>
|
|
<remarks>This is typically used by the object itself in response to its internal state changing.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDrawable.OnDraw(SkiaSharp.SKCanvas)">
|
|
<param name="canvas">The canvas to draw on.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKDrawable" /> types to draw the drawable to the canvas.</summary>
|
|
<remarks>If the generation ID is the same, then the resulting image must be the same.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDrawable.OnGetBounds">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKDrawable" /> types to return the conservative bounds of what the drawable will draw.</summary>
|
|
<returns>Returns the bounds.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDrawable.OnSnapshot">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKDrawable" /> types to create an immutable snapshot of the drawing.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPicture" /> snapshot.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDrawable.Snapshot">
|
|
<summary>Create an immutable snapshot of the drawing.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPicture" /> snapshot.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKDropShadowImageFilterShadowMode">
|
|
<summary>The various types of shadow modes for use with the <see cref="M:SkiaSharp.SKImageFilter.CreateDropShadow(System.Single,System.Single,System.Single,System.Single,SkiaSharp.SKColor,SkiaSharp.SKDropShadowImageFilterShadowMode,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter.CropRect)" /> method.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDropShadowImageFilterShadowMode.DrawShadowAndForeground">
|
|
<summary>Draw both the shadow and the foreground.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKDropShadowImageFilterShadowMode.DrawShadowOnly">
|
|
<summary>Draw the shadow only.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKDynamicMemoryWStream">
|
|
<summary>A writeable, dynamically-sized, memory-based stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKDynamicMemoryWStream">
|
|
<summary>Create a new instance of <see cref="T:SkiaSharp.SKDynamicMemoryWStream" /> with an empty buffer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDynamicMemoryWStream.CopyTo(SkiaSharp.SKWStream)">
|
|
<param name="dst">The stream to copy the data to.</param>
|
|
<summary>Copies the data from the current stream to the specified stream.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDynamicMemoryWStream.CopyTo(System.IntPtr)">
|
|
<param name="data">The memory location to copy the data to.</param>
|
|
<summary>Copies the data from the current stream to a memory location.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDynamicMemoryWStream.CopyTo(System.IO.Stream)">
|
|
<param name="dst">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDynamicMemoryWStream.CopyTo(System.Span{System.Byte})">
|
|
<param name="data">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDynamicMemoryWStream.CopyToData">
|
|
<summary>Returns a copy of the data written so far.</summary>
|
|
<returns>A copy of the data.</returns>
|
|
<remarks>The caller is responsible for releasing the memory.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDynamicMemoryWStream.DetachAsData">
|
|
<summary>Returns a <see cref="T:SkiaSharp.SKData" /> instance of the data in the current stream, and then resets the current stream.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKData" /> instance.</returns>
|
|
<remarks>After calling this method, this stream is reset to it's empty state.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDynamicMemoryWStream.DetachAsStream">
|
|
<summary>Returns a read-only stream with the current data, and then resets the current stream.</summary>
|
|
<returns>The stream with the data.</returns>
|
|
<remarks>After calling this method, this stream is reset to it's empty state.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDynamicMemoryWStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKDynamicMemoryWStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKDynamicMemoryWStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKDynamicMemoryWStream.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKEncodedImageFormat">
|
|
<summary>The various formats used by a <see cref="T:SkiaSharp.SKCodec" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Astc">
|
|
<summary>The ASTC image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Avif">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Bmp">
|
|
<summary>The BMP image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Dng">
|
|
<summary>The Adobe DNG image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Gif">
|
|
<summary>The GIF image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Heif">
|
|
<summary>The HEIF or High Efficiency Image File format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Ico">
|
|
<summary>The ICO image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Jpeg">
|
|
<summary>The JPEG image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Ktx">
|
|
<summary>The KTX image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Pkm">
|
|
<summary>The PKM image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Png">
|
|
<summary>The PNG image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Wbmp">
|
|
<summary>The WBMP image format.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedImageFormat.Webp">
|
|
<summary>The WEBP image format.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKEncodedInfo">
|
|
<summary>Describes the encoded image information.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKEncodedInfo(SkiaSharp.SKEncodedInfoColor)">
|
|
<param name="color">The color format.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKEncodedInfo" /> with the specified color format.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKEncodedInfo(SkiaSharp.SKEncodedInfoColor,SkiaSharp.SKEncodedInfoAlpha,System.Byte)">
|
|
<param name="color">The color format.</param>
|
|
<param name="alpha">The alpha format.</param>
|
|
<param name="bitsPerComponent">The number of bits per color component.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKEncodedInfo" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKEncodedInfo.Alpha">
|
|
<summary>Gets the encoded alpha format.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKEncodedInfo.BitsPerComponent">
|
|
<summary>Gets the number of bits per color component.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKEncodedInfo.BitsPerPixel">
|
|
<summary>Gets the number of bits per pixel.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKEncodedInfo.Color">
|
|
<summary>Gets the encoded color format.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKEncodedInfoAlpha">
|
|
<summary>The various alpha formats used by a <see cref="T:SkiaSharp.SKEncodedInfo" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoAlpha.Binary">
|
|
<summary>Each pixel is either fully opaque or fully transparent.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoAlpha.Opaque">
|
|
<summary>Each pixel is opaque.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoAlpha.Unpremul">
|
|
<summary>Each pixel has an unpremultiplied alpha.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKEncodedInfoColor">
|
|
<summary>The various color formats used by a <see cref="T:SkiaSharp.SKEncodedInfo" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Bgr">
|
|
<summary>The color format is BGR, without transparency. Typically found in BMP.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Bgra">
|
|
<summary>The color format is BGRA, with transparency. Typically found in BMP.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Bgrx">
|
|
<summary>The color format is BGR, without transparency. Typically found in BMP.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Gray">
|
|
<summary>The color format is grayscale, without transparency. Typically found in PNG and WBMP.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.GrayAlpha">
|
|
<summary>The color format is grayscale, with transparency. Typically found in PNG.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.InvertedCmyk">
|
|
<summary>The color format is CMYK, without transparency. Typically found in JPEG.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Palette">
|
|
<summary>The color format is palette based. Typically found in PNG, GIF and BMP.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Rgb">
|
|
<summary>The color format is RGB, without transparency. Typically found in PNG and RAW.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Rgba">
|
|
<summary>The color format is RGBA, with transparency. Typically found in PNG and RAW.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Ycck">
|
|
<summary>The color format is YCCK, without transparency. Typically found in JPEG.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Yuv">
|
|
<summary>The color format is YUV, without transparency. Typically found in JPEG and WEBP.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedInfoColor.Yuva">
|
|
<summary>The color format is YUVA, without transparency. Typically found in PNG and RAW.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKEncodedOrigin">
|
|
<summary>Represents various origin values returned by <see cref="P:SkiaSharp.SKCodec.Origin" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedOrigin.BottomLeft">
|
|
<summary>Reflected across x-axis.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedOrigin.BottomRight">
|
|
<summary>Rotated 180°.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedOrigin.Default">
|
|
<summary>This is equivalent to <see cref="F:SkiaSharp.SKEncodedOrigin.TopLeft" />.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedOrigin.LeftBottom">
|
|
<summary>Rotated 90° counter-clockwise.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedOrigin.LeftTop">
|
|
<summary>Reflected across x-axis. Rotated 90° counter-clockwise.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedOrigin.RightBottom">
|
|
<summary>Reflected across x-axis. Rotated 90° clockwise.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedOrigin.RightTop">
|
|
<summary>Rotated 90° clockwise.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedOrigin.TopLeft">
|
|
<summary>Default.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncodedOrigin.TopRight">
|
|
<summary>Reflected across y-axis.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKEncoding">
|
|
<summary>Text encoding definition.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncoding.Utf16">
|
|
<summary>UTF-16 encoding.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncoding.Utf32">
|
|
<summary>UTF-32 encoding.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKEncoding.Utf8">
|
|
<summary>UTF-8 encoding.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFileStream">
|
|
<summary>A seekable stream backed by a file on the file system.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFileStream(System.String)">
|
|
<param name="path">The existing file to open for reading.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKFileStream" /> that wraps the file with the specified path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFileStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKFileStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKFileStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFileStream.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFileStream.IsPathSupported(System.String)">
|
|
<param name="path">The path to check.</param>
|
|
<summary>Determines whether the specified path is supported by a <see cref="T:SkiaSharp.SKFileStream" />.</summary>
|
|
<returns>Returns <see langword="true" /> if the path is supported, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFileStream.IsValid">
|
|
<summary>Gets a value indicating whether the file could be opened.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFileStream.OpenStream(System.String)">
|
|
<param name="path">The path to the file to open.</param>
|
|
<summary>Opens a read-only stream to the specified file.</summary>
|
|
<returns>Returns a stream that contains the file contents.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFileWStream">
|
|
<summary>A writeable stream backed by a file on the file system.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFileWStream(System.String)">
|
|
<param name="path">The new or existing file to open for writing.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKFileWStream" /> that wraps the file with the specified path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFileWStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKFileWStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKFileWStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFileWStream.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFileWStream.IsPathSupported(System.String)">
|
|
<param name="path">The path to check.</param>
|
|
<summary>Determines whether the specified path is supported by a <see cref="T:SkiaSharp.SKFileWStream" />.</summary>
|
|
<returns>Returns <see langword="true" /> if the path is supported, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFileWStream.IsValid">
|
|
<summary>Gets a value indicating whether the file could be opened.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFileWStream.OpenStream(System.String)">
|
|
<param name="path">The path to the file to open.</param>
|
|
<summary>Opens a write-only stream to the specified file.</summary>
|
|
<returns>Returns a stream that contains the file contents.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFilterQuality">
|
|
<summary>Filter quality settings.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFilterQuality.High">
|
|
<summary>High quality.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFilterQuality.Low">
|
|
<summary>Low quality.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFilterQuality.Medium">
|
|
<summary>Medium quality.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFilterQuality.None">
|
|
<summary>Unspecified.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFont">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFont">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFont(SkiaSharp.SKTypeface,System.Single,System.Single,System.Single)">
|
|
<param name="typeface">To be added.</param>
|
|
<param name="size">To be added.</param>
|
|
<param name="scaleX">To be added.</param>
|
|
<param name="skewX">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.BaselineSnap">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.ContainsGlyph(System.Int32)">
|
|
<param name="codepoint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.ContainsGlyphs(System.ReadOnlySpan{System.Char})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.ContainsGlyphs(System.ReadOnlySpan{System.Int32})">
|
|
<param name="codepoints">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.ContainsGlyphs(System.String)">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.ContainsGlyphs(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding)">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.ContainsGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding)">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.CountGlyphs(System.ReadOnlySpan{System.Char})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.CountGlyphs(System.String)">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.CountGlyphs(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding)">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.CountGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding)">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.DisposeNative">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.Edging">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.EmbeddedBitmaps">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.Embolden">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.ForceAutoHinting">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetFontMetrics(SkiaSharp.SKFontMetrics@)">
|
|
<param name="metrics">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyph(System.Int32)">
|
|
<param name="codepoint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphOffsets(System.ReadOnlySpan{System.UInt16},System.Span{System.Single},System.Single)">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="offsets">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphPath(System.UInt16)">
|
|
<param name="glyph">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphPaths(System.ReadOnlySpan{System.UInt16},SkiaSharp.SKGlyphPathDelegate)">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="glyphPathDelegate">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphPositions(System.ReadOnlySpan{System.UInt16},System.Span{SkiaSharp.SKPoint},SkiaSharp.SKPoint)">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphs(System.ReadOnlySpan{System.Char},System.Span{System.UInt16})">
|
|
<param name="text">To be added.</param>
|
|
<param name="glyphs">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphs(System.ReadOnlySpan{System.Int32},System.Span{System.UInt16})">
|
|
<param name="codepoints">To be added.</param>
|
|
<param name="glyphs">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphs(System.String,System.Span{System.UInt16})">
|
|
<param name="text">To be added.</param>
|
|
<param name="glyphs">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphs(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding,System.Span{System.UInt16})">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="glyphs">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding,System.Span{System.UInt16})">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="glyphs">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.GetGlyphWidths(System.ReadOnlySpan{System.UInt16},System.Span{System.Single},System.Span{SkiaSharp.SKRect},SkiaSharp.SKPaint)">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="widths">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.Hinting">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.LinearMetrics">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.MeasureText(System.ReadOnlySpan{System.UInt16},SkiaSharp.SKPaint)">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFont.MeasureText(System.ReadOnlySpan{System.UInt16},SkiaSharp.SKRect@,SkiaSharp.SKPaint)">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.Metrics">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.ScaleX">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.Size">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.SkewX">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.Spacing">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.Subpixel">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFont.Typeface">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFontEdging">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontEdging.Alias">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontEdging.Antialias">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontEdging.SubpixelAntialias">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFontHinting">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontHinting.Full">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontHinting.None">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontHinting.Normal">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontHinting.Slight">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFontManager">
|
|
<summary>Manages a collection of fonts.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.CreateDefault">
|
|
<summary>Creates a new, default font manager.</summary>
|
|
<returns>Returns the new font manager.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.CreateTypeface(SkiaSharp.SKData,System.Int32)">
|
|
<param name="data">The data to read the typeface from.</param>
|
|
<param name="index">The TTC index.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKTypeface" /> from the specified <see cref="T:SkiaSharp.SKData" />.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKTypeface" />, or <see langword="null" /> if the data is not recognized.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.CreateTypeface(SkiaSharp.SKStreamAsset,System.Int32)">
|
|
<param name="stream">The stream to read the typeface from.</param>
|
|
<param name="index">The TTC index.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKTypeface" /> from the specified stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKTypeface" />, or <see langword="null" /> if the stream is not recognized.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.CreateTypeface(System.IO.Stream,System.Int32)">
|
|
<param name="stream">The stream to read the typeface from.</param>
|
|
<param name="index">The TTC index.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKTypeface" /> from the specified stream.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKTypeface" />, or <see langword="null" /> if the stream is not recognized.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.CreateTypeface(System.String,System.Int32)">
|
|
<param name="path">The path to the typeface.</param>
|
|
<param name="index">The TTC index.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKTypeface" /> from the specified file path.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKTypeface" />, or <see langword="null" /> if the file does not exist or the contents are not recognized.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontManager.Default">
|
|
<summary>Gets the default font manager.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKFontManager" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKFontManager" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontManager.FontFamilies">
|
|
<summary>Gets all the font family names loaded by this font manager.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontManager.FontFamilyCount">
|
|
<summary>Gets the number of font families available.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.GetFamilyName(System.Int32)">
|
|
<param name="index">The index of the font family name to retrieve.</param>
|
|
<summary>Returns the font family name for the specified index.</summary>
|
|
<returns>Returns the font family name.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.GetFontFamilies">
|
|
<summary>Returns all the font family names loaded by this font manager.</summary>
|
|
<returns>Returns an array of all the font family names loaded by this font manager.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.GetFontStyles(System.Int32)">
|
|
<param name="index">The index of the font style set to retrieve.</param>
|
|
<summary>Returns the font style set for the specified index.</summary>
|
|
<returns>Returns the font style set.</returns>
|
|
<remarks>The index must be in the range of [0, <see cref="P:SkiaSharp.SKFontManager.FontFamilyCount" />).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.GetFontStyles(System.String)">
|
|
<param name="familyName">The family name to use when searching.</param>
|
|
<summary>Use the system fallback to find the typeface styles for the given family.</summary>
|
|
<returns>Returns a <see cref="T:SkiaSharp.SKFontStyleSet" /> with all the font styles supported by the specified family.</returns>
|
|
<remarks>Never returns <see langword="null" /> and will return an empty set if the family is not found.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.Char)">
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.Int32)">
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.String,System.Char)">
|
|
<param name="familyName">The family name to use when searching.</param>
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.String,System.Int32)">
|
|
<param name="familyName">The family name to use when searching.</param>
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.String,System.String[],System.Char)">
|
|
<param name="familyName">The family name to use when searching.</param>
|
|
<param name="bcp47">The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh".</param>
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Note that `bcp47` is a combination of ISO 639, 15924, and3166-1 codes, so it
|
|
is fine to just pass a ISO 639 here. The first item is the least significant
|
|
fallback, and the last is the most significant.
|
|
|
|
If no specified codes match, any font with the requested character will be
|
|
matched.
|
|
|
|
This method may return `null` if no family can be found for the character
|
|
in the system fallback.]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.String,System.String[],System.Int32)">
|
|
<param name="familyName">The family name to try and use.</param>
|
|
<param name="bcp47">The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh".</param>
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Note that `bcp47` is a combination of ISO 639, 15924, and3166-1 codes, so it
|
|
is fine to just pass a ISO 639 here. The first item is the least significant
|
|
fallback, and the last is the most significant.
|
|
|
|
If no specified codes match, any font with the requested character will be
|
|
matched.
|
|
|
|
This method may return `null` if no family can be found for the character
|
|
in the system fallback.]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.String,SkiaSharp.SKFontStyle,System.String[],System.Int32)">
|
|
<param name="familyName">The family name to use when searching.</param>
|
|
<param name="style">The font style to use when searching.</param>
|
|
<param name="bcp47">The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh".</param>
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Note that `bcp47` is a combination of ISO 639, 15924, and3166-1 codes, so it
|
|
is fine to just pass a ISO 639 here. The first item is the least significant
|
|
fallback, and the last is the most significant.
|
|
|
|
If no specified codes match, any font with the requested character will be
|
|
matched.
|
|
|
|
This method may return `null` if no family can be found for the character
|
|
in the system fallback.]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.String,SkiaSharp.SKFontStyleWeight,SkiaSharp.SKFontStyleWidth,SkiaSharp.SKFontStyleSlant,System.String[],System.Char)">
|
|
<param name="familyName">The family name to use when searching.</param>
|
|
<param name="weight">The font weight to use when searching.</param>
|
|
<param name="width">The font width to use when searching.</param>
|
|
<param name="slant">The font slant to use when searching.</param>
|
|
<param name="bcp47">The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh".</param>
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Note that `bcp47` is a combination of ISO 639, 15924, and3166-1 codes, so it
|
|
is fine to just pass a ISO 639 here. The first item is the least significant
|
|
fallback, and the last is the most significant.
|
|
|
|
If no specified codes match, any font with the requested character will be
|
|
matched.
|
|
|
|
This method may return `null` if no family can be found for the character
|
|
in the system fallback.]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.String,SkiaSharp.SKFontStyleWeight,SkiaSharp.SKFontStyleWidth,SkiaSharp.SKFontStyleSlant,System.String[],System.Int32)">
|
|
<param name="familyName">The family name to use when searching.</param>
|
|
<param name="weight">The font weight to use when searching.</param>
|
|
<param name="width">The font width to use when searching.</param>
|
|
<param name="slant">The font slant to use when searching.</param>
|
|
<param name="bcp47">The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh".</param>
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Note that `bcp47` is a combination of ISO 639, 15924, and3166-1 codes, so it
|
|
is fine to just pass a ISO 639 here. The first item is the least significant
|
|
fallback, and the last is the most significant.
|
|
|
|
If no specified codes match, any font with the requested character will be
|
|
matched.
|
|
|
|
This method may return `null` if no family can be found for the character
|
|
in the system fallback.]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchCharacter(System.String,System.Int32,System.Int32,SkiaSharp.SKFontStyleSlant,System.String[],System.Int32)">
|
|
<param name="familyName">The family name to use when searching.</param>
|
|
<param name="weight">The font weight to use when searching.</param>
|
|
<param name="width">The font width to use when searching.</param>
|
|
<param name="slant">The font slant to use when searching.</param>
|
|
<param name="bcp47">The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh".</param>
|
|
<param name="character">The character to find a typeface for.</param>
|
|
<summary>Use the system fallback to find a typeface for the given character.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given character, or <see langword="null" /> if none was found.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Note that `bcp47` is a combination of ISO 639, 15924, and3166-1 codes, so it
|
|
is fine to just pass a ISO 639 here. The first item is the least significant
|
|
fallback, and the last is the most significant.
|
|
|
|
If no specified codes match, any font with the requested character will be
|
|
matched.
|
|
|
|
This method may return `null` if no family can be found for the character
|
|
in the system fallback.]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchFamily(System.String)">
|
|
<param name="familyName">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchFamily(System.String,SkiaSharp.SKFontStyle)">
|
|
<param name="familyName">The family name to use when searching.</param>
|
|
<param name="style">The font style to use when searching.</param>
|
|
<summary>Find the closest matching typeface to the specified family name and style.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given family name and style, or the default font if no matching font was found.</returns>
|
|
<remarks>Will never return <see langword="null" />, as it will return the default font if no matching font is found.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontManager.MatchTypeface(SkiaSharp.SKTypeface,SkiaSharp.SKFontStyle)">
|
|
<param name="face">The typeface to use when searching.</param>
|
|
<param name="style">The font style to use when searching.</param>
|
|
<summary>Find the closest matching typeface to the specified typeface and style.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKTypeface" /> that contains the given typeface and style, or the default font if no matching font was found.</returns>
|
|
<remarks>Will never return <see langword="null" />, as it will return the default font if no matching font is found.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFontMetrics">
|
|
<summary>Structure to represent measurements for a font.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.Ascent">
|
|
<summary>Gets the recommended distance above the baseline.</summary>
|
|
<value />
|
|
<remarks>Will be <= 0.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.AverageCharacterWidth">
|
|
<summary>Gets the average character width.</summary>
|
|
<value />
|
|
<remarks>Will be >= 0.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.Bottom">
|
|
<summary>Gets the greatest distance below the baseline for any glyph.</summary>
|
|
<value />
|
|
<remarks>Will be >= 0.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.CapHeight">
|
|
<summary>Gets the cap height.</summary>
|
|
<value />
|
|
<remarks>Will be > 0, or 0 if cannot be determined.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.Descent">
|
|
<summary>Gets the recommended distance below the baseline.</summary>
|
|
<value />
|
|
<remarks>Will be >= 0.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontMetrics.Equals(SkiaSharp.SKFontMetrics)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontMetrics.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontMetrics.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.Leading">
|
|
<summary>Gets the recommended distance to add between lines of text.</summary>
|
|
<value />
|
|
<remarks>Will be >= 0.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.MaxCharacterWidth">
|
|
<summary>Gets the max character width.</summary>
|
|
<value />
|
|
<remarks>Will be >= 0.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontMetrics.op_Equality(SkiaSharp.SKFontMetrics,SkiaSharp.SKFontMetrics)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontMetrics.op_Inequality(SkiaSharp.SKFontMetrics,SkiaSharp.SKFontMetrics)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.StrikeoutPosition">
|
|
<summary>Gets the position of the bottom of the strikeout stroke relative to the baseline.</summary>
|
|
<value />
|
|
<remarks>This value is typically negative when valid.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.StrikeoutThickness">
|
|
<summary>Gets the thickness of the strikeout.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.Top">
|
|
<summary>Gets the greatest distance above the baseline for any glyph.</summary>
|
|
<value />
|
|
<remarks>Will be <= 0.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.UnderlinePosition">
|
|
<summary>Gets the position of the top of the underline stroke relative to the baseline.</summary>
|
|
<value />
|
|
<remarks>
|
|
<para>Negative - underline should be drawn above baseline.</para>
|
|
<para>Positive - underline should be drawn below baseline.</para>
|
|
<para>Zero - underline should be drawn on baseline.underline position, or 0 if cannot be determined.</para>
|
|
<para>null - does not have an UnderlinePosition.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.UnderlineThickness">
|
|
<summary>Gets the thickness of the underline.</summary>
|
|
<value />
|
|
<remarks>
|
|
<para>0 - if the thickness can not be determined</para>
|
|
<para>null - if the thickness is not set.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.XHeight">
|
|
<summary>Gets the height of an 'x' in px.</summary>
|
|
<value />
|
|
<remarks>0 if no 'x' in face.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.XMax">
|
|
<summary>Gets the maximum bounding box x value for all glyphs.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontMetrics.XMin">
|
|
<summary>Gets the minimum bounding box x value for all glyphs.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFontStyle">
|
|
<summary>Represents a particular style (bold, italic, condensed) of a typeface.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFontStyle">
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKFontStyle" /> with a normal weight, a normal width and upright.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFontStyle(SkiaSharp.SKFontStyleWeight,SkiaSharp.SKFontStyleWidth,SkiaSharp.SKFontStyleSlant)">
|
|
<param name="weight">The weight (light or bold).</param>
|
|
<param name="width">The width (condensed or expanded).</param>
|
|
<param name="slant">The slant (italic).</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKFontStyle" /> with the specified weight, width and slant.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFontStyle(System.Int32,System.Int32,SkiaSharp.SKFontStyleSlant)">
|
|
<param name="weight">The weight (light or bold).</param>
|
|
<param name="width">The width (condensed or expanded).</param>
|
|
<param name="slant">The slant (italic).</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKFontStyle" /> with the specified weight, width and slant.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontStyle.Bold">
|
|
<summary>Gets a new upright font style that is bold.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontStyle.BoldItalic">
|
|
<summary>Gets a new italic font style that is bold.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontStyle.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKFontStyle" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKFontStyle" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontStyle.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontStyle.Italic">
|
|
<summary>Gets a new italic font style.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontStyle.Normal">
|
|
<summary>Gets a new normal (upright and not bold) font style.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontStyle.Slant">
|
|
<summary>Gets the slant of this style.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontStyle.Weight">
|
|
<summary>Gets the weight of this style.</summary>
|
|
<value />
|
|
<remarks>The weight could potentially be one of the values of <see cref="F:SkiaSharp.SKFontStyleWeight" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontStyle.Width">
|
|
<summary>Gets the width of this style.</summary>
|
|
<value />
|
|
<remarks>The weight could potentially be one of the values of <see cref="F:SkiaSharp.SKFontStyleWidth" />.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFontStyleSet">
|
|
<summary>Represets the set of styles for a particular font family.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFontStyleSet">
|
|
<summary>Creates a new, empty <see cref="T:SkiaSharp.SKFontStyleSet" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontStyleSet.Count">
|
|
<summary>Gets the number of font styles in the set.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontStyleSet.CreateTypeface(SkiaSharp.SKFontStyle)">
|
|
<param name="style">The font style to match.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKTypeface" /> with a style that is the closest match to the specified font style.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKTypeface" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontStyleSet.CreateTypeface(System.Int32)">
|
|
<param name="index">The index of the font style to match.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKTypeface" /> with the style that is the closest match to the style at the specified index.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKTypeface" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontStyleSet.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKFontStyleSet" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKFontStyleSet" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontStyleSet.GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the font styles.</summary>
|
|
<returns>Returns an enumerator.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontStyleSet.GetStyleName(System.Int32)">
|
|
<param name="index">The index of the font style.</param>
|
|
<summary>Returns the name of the font style.</summary>
|
|
<returns>Returns the name of the font style.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFontStyleSet.Item(System.Int32)">
|
|
<param name="index">The index of the font style.</param>
|
|
<summary>Gets the font style at the specified index.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFontStyleSet.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the font styles.</summary>
|
|
<returns>Returns an enumerator.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFontStyleSlant">
|
|
<summary>Various font slants for use with <see cref="T:SkiaSharp.SKTypeface" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleSlant.Italic">
|
|
<summary>The italic font slant, in which the slanted characters appear as they were designed.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleSlant.Oblique">
|
|
<summary>The oblique font slant, in which the characters are artificially slanted.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleSlant.Upright">
|
|
<summary>The upright/normal font slant.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFontStyleWeight">
|
|
<summary>Various predefined font weights for use with <see cref="T:SkiaSharp.SKTypeface" />.</summary>
|
|
<remarks>Font weights can range from anywhere between 100 to 1000 (inclusive).</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.Black">
|
|
<summary>A thick font weight of 900.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.Bold">
|
|
<summary>A thick font weight of 700. This is the default for a bold font.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.ExtraBlack">
|
|
<summary>A thick font weight of 1000.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.ExtraBold">
|
|
<summary>A thick font weight of 800.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.ExtraLight">
|
|
<summary>A thin font weight of 200.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.Invisible">
|
|
<summary>The font has no thickness at all.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.Light">
|
|
<summary>A thin font weight of 300.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.Medium">
|
|
<summary>A thicker font weight of 500.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.Normal">
|
|
<summary>A typical font weight of 400. This is the default font weight.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.SemiBold">
|
|
<summary>A thick font weight of 600.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWeight.Thin">
|
|
<summary>A thin font weight of 100.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFontStyleWidth">
|
|
<summary>Various predefined font widths for use with <see cref="T:SkiaSharp.SKTypeface" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWidth.Condensed">
|
|
<summary>A condensed font width of 3.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWidth.Expanded">
|
|
<summary>An expanded font width of 7.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWidth.ExtraCondensed">
|
|
<summary>A condensed font width of 2.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWidth.ExtraExpanded">
|
|
<summary>An expanded font width of 8.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWidth.Normal">
|
|
<summary>A normal font width of 5. This is the default font width.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWidth.SemiCondensed">
|
|
<summary>A condensed font width of 4.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWidth.SemiExpanded">
|
|
<summary>An expanded font width of 6.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWidth.UltraCondensed">
|
|
<summary>A condensed font width of 1.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFontStyleWidth.UltraExpanded">
|
|
<summary>An expanded font width of 9.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFrontBufferedManagedStream">
|
|
<summary>A read-only stream that buffers the specified first chunk of bytes.</summary>
|
|
<remarks>This is useful for decoding images using streams that are not seekable, since <see cref="T:SkiaSharp.SKCodec" /> needs to read the first few bytes to determine the codec to use.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFrontBufferedManagedStream(SkiaSharp.SKStream,System.Int32)">
|
|
<param name="nativeStream">The stream to buffer.</param>
|
|
<param name="bufferSize">The number of bytes to buffer.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKFrontBufferedStream" /> that wraps the specified stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFrontBufferedManagedStream(System.IO.Stream,System.Int32)">
|
|
<param name="managedStream">The stream to buffer.</param>
|
|
<param name="bufferSize">The number of bytes to buffer.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKFrontBufferedStream" /> that wraps the specified stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFrontBufferedManagedStream(SkiaSharp.SKStream,System.Int32,System.Boolean)">
|
|
<param name="nativeStream">The stream to buffer.</param>
|
|
<param name="bufferSize">The number of bytes to buffer.</param>
|
|
<param name="disposeUnderlyingStream">Whether or not to dispose the underlying stream when this stream is disposed.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKFrontBufferedStream" /> that wraps the specified stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFrontBufferedManagedStream(System.IO.Stream,System.Int32,System.Boolean)">
|
|
<param name="managedStream">The stream to buffer.</param>
|
|
<param name="bufferSize">The number of bytes to buffer.</param>
|
|
<param name="disposeUnderlyingStream">Whether or not to dispose the underlying stream when this stream is disposed.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKFrontBufferedStream" /> that wraps the specified stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKFrontBufferedManagedStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKFrontBufferedManagedStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.DisposeManaged">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKNativeObject" /> types to destroy any managed objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnCreateNew">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to copy the current stream.</summary>
|
|
<returns>Returns a pointer to the new <see cref="T:SkiaSharp.SKStreamAsset" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnGetLength">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to return the total length of the stream.</summary>
|
|
<returns>Returns the total length of the stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnGetPosition">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to get the current position in the stream</summary>
|
|
<returns>Returns the current position in the stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnHasLength">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to indicate whether this stream can report it's total length.</summary>
|
|
<returns>Returns a value indicating whether this stream can report it's total length.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnHasPosition">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to indicate whether this stream can report it's current position.</summary>
|
|
<returns>Returns a value indicating whether this stream can report it's current position.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnIsAtEnd">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to indicate whether all the bytes in the stream have been read.</summary>
|
|
<returns>Returns a value indicating whether all the bytes in the stream have been read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnMove(System.Int32)">
|
|
<param name="offset">The relative offset.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to seek to a relative offset.</summary>
|
|
<returns>Returns <see langword="true" /> if seeking is supported and the seek was successful, otherwise <see langword="false" />.</returns>
|
|
<remarks>If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnPeek(System.IntPtr,System.IntPtr)">
|
|
<param name="buffer">The buffer to read into.</param>
|
|
<param name="size">The number of bytes to read.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to copy the specified number of bytes into the specified buffer.</summary>
|
|
<returns>Returns the number of bytes actually peeked/copied.</returns>
|
|
<remarks>The stream's cursor must be returned to the position before this method was called.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnRead(System.IntPtr,System.IntPtr)">
|
|
<param name="buffer">The buffer to read into.</param>
|
|
<param name="size">The number of bytes to read.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to copy the specified number of bytes into the specified buffer.</summary>
|
|
<returns>Returns the number of bytes actually read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnRewind">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to rewind the current stream.</summary>
|
|
<returns>Returns <see langword="true" /> if the stream is known to be at the beginning after this call returns.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedManagedStream.OnSeek(System.IntPtr)">
|
|
<param name="position">The absolute position.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to seek to an absolute position.</summary>
|
|
<returns>Returns <see langword="true" /> if seeking is supported and the seek was successful, otherwise <see langword="false" />.</returns>
|
|
<remarks>If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end).</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKFrontBufferedStream">
|
|
<summary>A read-only stream that buffers the specified first chunk of bytes.</summary>
|
|
<remarks>This is useful for decoding images using streams that are not seekable, since <see cref="T:SkiaSharp.SKCodec" /> needs to read the first few bytes to determine the codec to use.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFrontBufferedStream(System.IO.Stream)">
|
|
<param name="stream">The stream to buffer.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKFrontBufferedStream" /> that wraps the specified stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFrontBufferedStream(System.IO.Stream,System.Boolean)">
|
|
<param name="stream">The stream to buffer.</param>
|
|
<param name="disposeUnderlyingStream">Whether or not to dispose the underlying stream when this stream is disposed.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKFrontBufferedStream" /> that wraps the specified stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFrontBufferedStream(System.IO.Stream,System.Int64)">
|
|
<param name="stream">The stream to buffer.</param>
|
|
<param name="bufferSize">The number of bytes to buffer.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKFrontBufferedStream" /> that wraps the specified stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKFrontBufferedStream(System.IO.Stream,System.Int64,System.Boolean)">
|
|
<param name="stream">The stream to buffer.</param>
|
|
<param name="bufferSize">The number of bytes to buffer.</param>
|
|
<param name="disposeUnderlyingStream">Whether or not to dispose the underlying stream when this stream is disposed.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKFrontBufferedStream" /> that wraps the specified stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFrontBufferedStream.CanRead">
|
|
<summary>Gets a value indicating whether the current stream supports reading.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFrontBufferedStream.CanSeek">
|
|
<summary>Gets a value indicating whether the current stream supports seeking.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFrontBufferedStream.CanWrite">
|
|
<summary>Gets a value indicating whether the current stream supports writing.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKFrontBufferedStream.DefaultBufferSize">
|
|
<summary>The default number of bytes to buffer (4096 bytes).</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKFrontBufferedStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKFrontBufferedStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedStream.Flush">
|
|
<summary>Clears all buffers for this stream and causes any buffered data to be written to the underlying device.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFrontBufferedStream.Length">
|
|
<summary>Gets the stream length in bytes.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKFrontBufferedStream.Position">
|
|
<summary>Gets the position within the current stream.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedStream.Read(System.Byte[],System.Int32,System.Int32)">
|
|
<param name="buffer">The buffer to which bytes are to be copied.</param>
|
|
<param name="offset">The byte offset in the buffer at which to begin reading bytes.</param>
|
|
<param name="count">The number of bytes to be read.</param>
|
|
<summary>Copies bytes from the current buffered stream to an array.</summary>
|
|
<returns>Returns the total number of bytes read into the buffer array.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
|
<param name="offset">The byte offset relative to the specified origin.</param>
|
|
<param name="origin">The reference point from which to obtain the new position.</param>
|
|
<summary>Sets the position within the current buffered stream.</summary>
|
|
<returns>Returns the new position within the current buffered stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedStream.SetLength(System.Int64)">
|
|
<param name="value">An integer indicating the desired length of the current buffered stream in bytes.</param>
|
|
<summary>Sets the length of the buffered stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKFrontBufferedStream.Write(System.Byte[],System.Int32,System.Int32)">
|
|
<param name="buffer">The byte array from which to copy count bytes to the current buffered stream.</param>
|
|
<param name="offset">The offset in the buffer at which to begin copying bytes to the current buffered stream.</param>
|
|
<param name="count">The number of bytes to be written to the current buffered stream.</param>
|
|
<summary>Copies bytes to the buffered stream and advances the current position within the buffered stream by the number of bytes written.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKGlyphPathDelegate">
|
|
<param name="path">To be added.</param>
|
|
<param name="matrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKGraphics">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.DumpMemoryStatistics(SkiaSharp.SKTraceMemoryDump)">
|
|
<param name="dump">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.GetFontCacheCountLimit">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.GetFontCacheCountUsed">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.GetFontCacheLimit">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.GetFontCachePointSizeLimit">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.GetFontCacheUsed">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.GetResourceCacheSingleAllocationByteLimit">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.GetResourceCacheTotalByteLimit">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.GetResourceCacheTotalBytesUsed">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.Init">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.PurgeAllCaches">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.PurgeFontCache">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.PurgeResourceCache">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.SetFontCacheCountLimit(System.Int32)">
|
|
<param name="count">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.SetFontCacheLimit(System.Int64)">
|
|
<param name="bytes">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.SetFontCachePointSizeLimit(System.Int32)">
|
|
<param name="count">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.SetResourceCacheSingleAllocationByteLimit(System.Int64)">
|
|
<param name="bytes">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKGraphics.SetResourceCacheTotalByteLimit(System.Int64)">
|
|
<param name="bytes">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKHighContrastConfig">
|
|
<summary>High contrast configuration settings for use with <see cref="M:SkiaSharp.SKColorFilter.CreateHighContrast(SkiaSharp.SKHighContrastConfig)" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKHighContrastConfig(System.Boolean,SkiaSharp.SKHighContrastConfigInvertStyle,System.Single)">
|
|
<param name="grayscale">Whether or not the color will be converted to grayscale.</param>
|
|
<param name="invertStyle">Whether or not to invert brightness, lightness, or neither.</param>
|
|
<param name="contrast">The amount to adjust the contrast by, in the range -1.0 through 1.0.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKHighContrastConfig" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKHighContrastConfig.Contrast">
|
|
<summary>Gets or sets the amount to adjust the contrast by, in the range -1.0 through 1.0..</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKHighContrastConfig.Default">
|
|
<summary>Gets a new instance with the values set to the defaults.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKHighContrastConfig.Equals(SkiaSharp.SKHighContrastConfig)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKHighContrastConfig.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKHighContrastConfig.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKHighContrastConfig.Grayscale">
|
|
<summary>Gets or sets a value indicating whether the color will be converted to grayscale.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKHighContrastConfig.InvertStyle">
|
|
<summary>Gets or sets a value indicating whether to invert brightness, lightness, or neither.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKHighContrastConfig.IsValid">
|
|
<summary>Gets a value indicating if the configuration is valid.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKHighContrastConfig.op_Equality(SkiaSharp.SKHighContrastConfig,SkiaSharp.SKHighContrastConfig)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKHighContrastConfig.op_Inequality(SkiaSharp.SKHighContrastConfig,SkiaSharp.SKHighContrastConfig)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKHighContrastConfigInvertStyle">
|
|
<summary>Various invert styles for high contrast calculations.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKHighContrastConfigInvertStyle.InvertBrightness">
|
|
<summary>Invert the brightness.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKHighContrastConfigInvertStyle.InvertLightness">
|
|
<summary>Invert the lightness.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKHighContrastConfigInvertStyle.NoInvert">
|
|
<summary>Do not invert.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKHorizontalRunBuffer">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKHorizontalRunBuffer.GetPositionSpan">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKHorizontalRunBuffer.SetPositions(System.ReadOnlySpan{System.Single})">
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SkiaExtensions">
|
|
<summary>Convenience methods for <see cref="T:SkiaSharp.SKPixelGeometry" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.GetAlphaType(SkiaSharp.SKColorType,SkiaSharp.SKAlphaType)">
|
|
<param name="colorType">To be added.</param>
|
|
<param name="alphaType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.GetBytesPerPixel(SkiaSharp.SKColorType)">
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.IsBgr(SkiaSharp.SKPixelGeometry)">
|
|
<param name="pg">The pixel geometry to test.</param>
|
|
<summary>Returns true if the pixel geometry is BGR.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.IsHorizontal(SkiaSharp.SKPixelGeometry)">
|
|
<param name="pg">The pixel geometry to test.</param>
|
|
<summary>Returns true if the pixel geometry is horizontal.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.IsRgb(SkiaSharp.SKPixelGeometry)">
|
|
<param name="pg">The pixel geometry to test.</param>
|
|
<summary>Returns true if the pixel geometry is RGB.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.IsVertical(SkiaSharp.SKPixelGeometry)">
|
|
<param name="pg">The pixel geometry to test.</param>
|
|
<summary>Returns true if the pixel geometry is vertical.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToColorChannel(SkiaSharp.SKDisplacementMapEffectChannelSelectorType)">
|
|
<param name="channelSelectorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToColorSpaceTransferFn(SkiaSharp.SKColorSpaceRenderTargetGamma)">
|
|
<param name="gamma">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToColorSpaceTransferFn(SkiaSharp.SKNamedGamma)">
|
|
<param name="gamma">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToColorSpaceXyz(SkiaSharp.SKColorSpaceGamut)">
|
|
<param name="gamut">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToColorSpaceXyz(SkiaSharp.SKMatrix44)">
|
|
<param name="matrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToColorType(SkiaSharp.GRPixelConfig)">
|
|
<param name="config">The <see cref="T:SkiaSharp.GRPixelConfig" /> to convert.</param>
|
|
<summary>Converts a <see cref="T:SkiaSharp.GRPixelConfig" /> to an equivalent <see cref="T:SkiaSharp.SKColorType" />, if possible.</summary>
|
|
<returns>Returns the equivalent <see cref="T:SkiaSharp.SKColorType" />, or <see cref="F:SkiaSharp.SKColorType.Unknown" /> if there is none.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToFilterQuality(SkiaSharp.SKBitmapResizeMethod)">
|
|
<param name="method">The <see cref="T:SkiaSharp.SKBitmapResizeMethod" /> to convert.</param>
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKBitmapResizeMethod" /> to an equivalent <see cref="T:SkiaSharp.SKFilterQuality" />.</summary>
|
|
<returns>Returns the equivalent <see cref="T:SkiaSharp.SKFilterQuality" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToGlSizedFormat(SkiaSharp.GRPixelConfig)">
|
|
<param name="config">The <see cref="T:SkiaSharp.GRPixelConfig" /> to convert.</param>
|
|
<summary>Converts a <see cref="T:SkiaSharp.GRPixelConfig" /> to the equivalent OpenGL sized format, if possible.</summary>
|
|
<returns>Returns the equivalent OpenGL sized format, or 0 if there is none.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToGlSizedFormat(SkiaSharp.SKColorType)">
|
|
<param name="colorType">The <see cref="T:SkiaSharp.SKColorType" /> to convert.</param>
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKColorType" /> to the equivalent OpenGL sized format, if possible.</summary>
|
|
<returns>Returns the equivalent OpenGL sized format, or 0 if there is none.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToPixelConfig(SkiaSharp.SKColorType)">
|
|
<param name="colorType">The <see cref="T:SkiaSharp.SKColorType" /> to convert.</param>
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKColorType" /> to an equivalent <see cref="T:SkiaSharp.GRPixelConfig" />, if possible.</summary>
|
|
<returns>Returns the equivalent <see cref="T:SkiaSharp.GRPixelConfig" />, or <see cref="F:SkiaSharp.GRPixelConfig.Unknown" /> if there is none.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToShaderTileMode(SkiaSharp.SKMatrixConvolutionTileMode)">
|
|
<param name="tileMode">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaExtensions.ToTextEncoding(SkiaSharp.SKEncoding)">
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SkiaSharpVersion">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SkiaSharpVersion.CheckNativeLibraryCompatible(System.Boolean)">
|
|
<param name="throwIfIncompatible">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SkiaSharpVersion.Native">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SkiaSharpVersion.NativeMinimum">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKImage">
|
|
<summary>An abstraction for drawing a rectangle of pixels.</summary>
|
|
<remarks>
|
|
<para>An image is an abstraction of pixels, though the particular type of image could be actually storing its data on the GPU, or as drawing commands (picture or PDF or otherwise), ready to be played back into another canvas.</para>
|
|
<para />
|
|
<para>The content of an image is always immutable, though the actual storage may change, if for example that image can be recreated via encoded data or other means.</para>
|
|
<para />
|
|
<para>An image always has a non-zero dimensions. If there is a request to create a new image, either directly or via a surface, and either of the requested dimensions are zero, then <see langword="null" /> will be returned.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.AlphaType">
|
|
<summary>Gets the configured <see cref="T:SkiaSharp.SKAlphaType" /> for the bitmap.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ApplyImageFilter(SkiaSharp.SKImageFilter,SkiaSharp.SKRectI,SkiaSharp.SKRectI,SkiaSharp.SKRectI@,SkiaSharp.SKPoint@)">
|
|
<param name="filter">The filter to apply to the current image.</param>
|
|
<param name="subset">The active portion of this image.</param>
|
|
<param name="clipBounds">Constrains the device-space extent of the image to the given rectangle.</param>
|
|
<param name="outSubset">The active portion of the resulting image</param>
|
|
<param name="outOffset">The amount to translate the resulting image relative to the source when it is drawn.</param>
|
|
<summary>Applies a given image filter to this image, and return the filtered result.</summary>
|
|
<returns>Returns the resulting image after the filter is applied, or <see langword="null" /> if the image could not be created or would be transparent black (#00000000).</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ApplyImageFilter(SkiaSharp.SKImageFilter,SkiaSharp.SKRectI,SkiaSharp.SKRectI,SkiaSharp.SKRectI@,SkiaSharp.SKPointI@)">
|
|
<param name="filter">The filter to apply to the current image.</param>
|
|
<param name="subset">The active portion of this image.</param>
|
|
<param name="clipBounds">Constrains the device-space extent of the image to the given rectangle.</param>
|
|
<param name="outSubset">The active portion of the resulting image</param>
|
|
<param name="outOffset">The amount to translate the resulting image relative to the source when it is drawn.</param>
|
|
<summary>Applies a given image filter to this image, and return the filtered result.</summary>
|
|
<returns>Returns the resulting image after the filter is applied, or <see langword="null" /> if the image could not be created or would be transparent black (#00000000).</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ApplyImageFilter(SkiaSharp.GRContext,SkiaSharp.SKImageFilter,SkiaSharp.SKRectI,SkiaSharp.SKRectI,SkiaSharp.SKRectI@,SkiaSharp.SKPointI@)">
|
|
<param name="context">To be added.</param>
|
|
<param name="filter">To be added.</param>
|
|
<param name="subset">To be added.</param>
|
|
<param name="clipBounds">To be added.</param>
|
|
<param name="outSubset">To be added.</param>
|
|
<param name="outOffset">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ApplyImageFilter(SkiaSharp.GRRecordingContext,SkiaSharp.SKImageFilter,SkiaSharp.SKRectI,SkiaSharp.SKRectI,SkiaSharp.SKRectI@,SkiaSharp.SKPointI@)">
|
|
<param name="context">To be added.</param>
|
|
<param name="filter">To be added.</param>
|
|
<param name="subset">To be added.</param>
|
|
<param name="clipBounds">To be added.</param>
|
|
<param name="outSubset">To be added.</param>
|
|
<param name="outOffset">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.ColorSpace">
|
|
<summary>Gets the image color space.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.ColorType">
|
|
<summary>Gets the image color type.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.Create(SkiaSharp.SKImageInfo)">
|
|
<param name="info">The image information to use.</param>
|
|
<summary>Creates a new raster-based <see cref="T:SkiaSharp.SKImage" /> using the specified information.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImage" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKImage" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKImage" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.Encode">
|
|
<summary>Encodes the image using the <see cref="F:SkiaSharp.SKImageEncodeFormat.Png" /> format.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKData" /> wrapping the encoded image.</returns>
|
|
<remarks>Use the overload that takes a <see cref="T:SkiaSharp.SKImageEncodeFormat" /> if you want to encode in a different format.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.Encode(SkiaSharp.SKPixelSerializer)">
|
|
<param name="serializer">The serializer to use to encode the image.</param>
|
|
<summary>Encodes the image using the specified serializer.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKData" /> wrapping the encoded image.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.Encode(SkiaSharp.SKEncodedImageFormat,System.Int32)">
|
|
<param name="format">The file format used to encode the image.</param>
|
|
<param name="quality">The quality level to use for the image. This is in the range from 0-100.</param>
|
|
<summary>Encodes the image using the specified format.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKData" /> wrapping the encoded image.</returns>
|
|
<remarks>The quality is a suggestion, and not all formats (for example, PNG) respect or support it.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.EncodedData">
|
|
<summary>Gets the encoded image pixels as a <see cref="T:SkiaSharp.SKData" />, if the image was created from supported encoded stream format.</summary>
|
|
<value />
|
|
<remarks>Returns <see langword="null" /> if the image mage contents are not encoded.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<summary>Creates a new image from the specified texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks>SkiaSharp will delete or recycle the texture when the image is released.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing OpenGL texture.</param>
|
|
<summary>Creates a new image from the specified OpenGL texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks>SkiaSharp will delete or recycle the OpenGL texture when the image is released.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
|
|
<remarks>SkiaSharp will delete or recycle the texture when the image is released.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc,SkiaSharp.SKAlphaType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<param name="alpha">The alpha type of the texture.</param>
|
|
<summary>Creates a new image from the specified texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks>SkiaSharp will delete or recycle the texture when the image is released.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc,SkiaSharp.SKAlphaType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing OpenGL texture.</param>
|
|
<param name="alpha">The alpha type of the texture.</param>
|
|
<summary>Creates a new image from the specified OpenGL texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks>SkiaSharp will delete or recycle the texture when the image is released.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
|
|
<remarks>SkiaSharp will delete or recycle the texture when the image is released.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<param name="alpha">The transparency mode to use for the image.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
|
|
<remarks>SkiaSharp will delete or recycle the texture when the image is released.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="alpha">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<param name="alpha">The transparency mode to use for the image.</param>
|
|
<param name="colorspace">The colorspace to use for the image.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported.</returns>
|
|
<remarks>SkiaSharp will delete or recycle the texture when the image is released.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromAdoptedTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="alpha">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromBitmap(SkiaSharp.SKBitmap)">
|
|
<param name="bitmap">The bitmap that will be used as the source for the image.</param>
|
|
<summary>Creates a new image from the provided <see cref="T:SkiaSharp.SKBitmap" />.</summary>
|
|
<returns>An image whose contents are the contents of the specified bitmap.</returns>
|
|
<remarks>If the bitmap is marked immutable, and its pixel memory is shareable, it may be shared instead of copied.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromEncodedData(SkiaSharp.SKData)">
|
|
<param name="data">The data holding the encoded image.</param>
|
|
<summary>Creates a new image from an encoded image wrapped by the data.</summary>
|
|
<returns>The decoded image, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromEncodedData(SkiaSharp.SKStream)">
|
|
<param name="data">The stream holding the encoded image.</param>
|
|
<summary>Creates a new image from an encoded image stream.</summary>
|
|
<returns>The decoded image, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromEncodedData(System.Byte[])">
|
|
<param name="data">The buffer holding the encoded image.</param>
|
|
<summary>Creates a new image from an encoded image buffer.</summary>
|
|
<returns>The decoded image, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromEncodedData(System.IO.Stream)">
|
|
<param name="data">The stream holding the encoded image.</param>
|
|
<summary>Creates a new image from an encoded image stream.</summary>
|
|
<returns>The decoded image, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromEncodedData(System.ReadOnlySpan{System.Byte})">
|
|
<param name="data">The buffer holding the encoded image.</param>
|
|
<summary>Creates a new image from an encoded image buffer.</summary>
|
|
<returns>The decoded image, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromEncodedData(System.String)">
|
|
<param name="filename">The path to an encoded image on the file system.</param>
|
|
<summary>Creates a new image from an encoded image file.</summary>
|
|
<returns>The decoded image, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromEncodedData(SkiaSharp.SKData,SkiaSharp.SKRectI)">
|
|
<param name="data">The data holding the encoded image.</param>
|
|
<param name="subset">The bounds for a subset of the image.</param>
|
|
<summary>Creates a new image from an encoded image wrapped by the data.</summary>
|
|
<returns>The decoded image, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPicture(SkiaSharp.SKPicture,SkiaSharp.SKSizeI)">
|
|
<param name="picture">The picture.</param>
|
|
<param name="dimensions">The size of the raster image.</param>
|
|
<summary>Creates a new image from the provided <see cref="T:SkiaSharp.SKPicture" />.</summary>
|
|
<returns>An image whose contents is the picture.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPicture(SkiaSharp.SKPicture,SkiaSharp.SKSizeI,SkiaSharp.SKMatrix)">
|
|
<param name="picture">The picture.</param>
|
|
<param name="dimensions">The size of the raster image.</param>
|
|
<param name="matrix">The matrix to use when reading the image.</param>
|
|
<summary>Creates a new image from the provided <see cref="T:SkiaSharp.SKPicture" />.</summary>
|
|
<returns>An image whose contents is the picture.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPicture(SkiaSharp.SKPicture,SkiaSharp.SKSizeI,SkiaSharp.SKPaint)">
|
|
<param name="picture">The picture.</param>
|
|
<param name="dimensions">The size of the raster image.</param>
|
|
<param name="paint">The paint to use when reading the image.</param>
|
|
<summary>Creates a new image from the provided <see cref="T:SkiaSharp.SKPicture" />.</summary>
|
|
<returns>An image whose contents is the picture.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPicture(SkiaSharp.SKPicture,SkiaSharp.SKSizeI,SkiaSharp.SKMatrix,SkiaSharp.SKPaint)">
|
|
<param name="picture">The picture.</param>
|
|
<param name="dimensions">The size of the raster image.</param>
|
|
<param name="matrix">The matrix to use when reading the image.</param>
|
|
<param name="paint">The paint to use when reading the image.</param>
|
|
<summary>Creates a new image from the provided <see cref="T:SkiaSharp.SKPicture" />.</summary>
|
|
<returns>An image whose contents is the picture.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixmap that contains the image information and buffer location.</param>
|
|
<summary>Creates a new image from a copy of an in-memory buffer.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,SkiaSharp.SKStream)">
|
|
<param name="info">The image information describing the encoding of the image in the stream.</param>
|
|
<param name="pixels">The stream of image data.</param>
|
|
<summary>Creates a new image from a copy of the stream data.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,System.Byte[])">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="pixels">The buffer of image data.</param>
|
|
<summary>Creates a new image from a copy of an in-memory buffer.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,System.IntPtr)">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="pixels">The pointer to the image in memory.</param>
|
|
<summary>Creates a new image from a copy of an in-memory buffer.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,System.IO.Stream)">
|
|
<param name="info">The image information describing the encoding of the image in the stream.</param>
|
|
<param name="pixels">The stream of image data.</param>
|
|
<summary>Creates a new image from a copy of the stream data.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,System.ReadOnlySpan{System.Byte})">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="pixels">The buffer of image data.</param>
|
|
<summary>Creates a new image from a copy of an in-memory buffer.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,SkiaSharp.SKStream,System.Int32)">
|
|
<param name="info">The image information describing the encoding of the image in the stream.</param>
|
|
<param name="pixels">The stream of image data.</param>
|
|
<param name="rowBytes">The specified the number of bytes used per row in the image.</param>
|
|
<summary>Creates a new image from a copy of the stream data.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,System.Byte[],System.Int32)">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="pixels">The buffer of image data.</param>
|
|
<param name="rowBytes">The specified the number of bytes used per row in the image.</param>
|
|
<summary>Creates a new image from a copy of an in-memory buffer.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="pixels">The pointer to the image in memory.</param>
|
|
<param name="rowBytes">The specified the number of bytes used per row in the image.</param>
|
|
<summary>Creates a new image from a copy of an in-memory buffer.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,System.IO.Stream,System.Int32)">
|
|
<param name="info">The image information describing the encoding of the image in the stream.</param>
|
|
<param name="pixels">The stream of image data.</param>
|
|
<param name="rowBytes">The specified the number of bytes used per row in the image.</param>
|
|
<summary>Creates a new image from a copy of the stream data.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,System.ReadOnlySpan{System.Byte},System.Int32)">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="pixels">The buffer of image data.</param>
|
|
<param name="rowBytes">The specified the number of bytes used per row in the image.</param>
|
|
<summary>Creates a new image from a copy of an in-memory buffer.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelCopy(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKColorTable)">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="pixels">The pointer to the image in memory.</param>
|
|
<param name="rowBytes">The specified the number of bytes used per row in the image.</param>
|
|
<param name="ctable">The color table to use with the image data.</param>
|
|
<summary>Creates a new image from a copy of an in-memory buffer.</summary>
|
|
<returns>A new image with a copy of the contents of the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixelData(SkiaSharp.SKImageInfo,SkiaSharp.SKData,System.Int32)">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="data">The data object that contains the pixel data.</param>
|
|
<param name="rowBytes">The specified the number of bytes used per row in the image.</param>
|
|
<summary>Creates a new image from an in-memory buffer.</summary>
|
|
<returns>A new image wrapping the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixels(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixmap that contains the image information and buffer location.</param>
|
|
<summary>Creates a new image from an in-memory buffer.</summary>
|
|
<returns>A new image wrapping the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixels(SkiaSharp.SKImageInfo,SkiaSharp.SKData)">
|
|
<param name="info">To be added.</param>
|
|
<param name="data">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixels(SkiaSharp.SKImageInfo,System.IntPtr)">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="pixels">The pointer to the image in memory.</param>
|
|
<summary>Creates a new image from an in-memory buffer.</summary>
|
|
<returns>A new image wrapping the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixels(SkiaSharp.SKPixmap,SkiaSharp.SKImageRasterReleaseDelegate)">
|
|
<param name="pixmap">The pixmap that contains the image information and buffer location.</param>
|
|
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
|
|
<summary>Creates a new image from an in-memory buffer.</summary>
|
|
<returns>A new image wrapping the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixels(SkiaSharp.SKImageInfo,SkiaSharp.SKData,System.Int32)">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="data">The data object that contains the pixel data.</param>
|
|
<param name="rowBytes">The specified the number of bytes used per row in the image.</param>
|
|
<summary>Creates a new image from an in-memory buffer.</summary>
|
|
<returns>A new image wrapping the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)">
|
|
<param name="info">The image information describing the encoding of the image in memory.</param>
|
|
<param name="pixels">The pointer to the image in memory.</param>
|
|
<param name="rowBytes">The specified the number of bytes used per row in the image.</param>
|
|
<summary>Creates a new image from an in-memory buffer.</summary>
|
|
<returns>A new image wrapping the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromPixels(SkiaSharp.SKPixmap,SkiaSharp.SKImageRasterReleaseDelegate,System.Object)">
|
|
<param name="pixmap">The pixmap that contains the image information and buffer location.</param>
|
|
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
|
|
<param name="releaseContext">The user data to use when invoking the delegate.</param>
|
|
<summary>Creates a new image from an in-memory buffer.</summary>
|
|
<returns>A new image wrapping the specified buffer, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<summary>Creates a new image from the specified texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<summary>Creates a new image from the specified OpenGL texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc,SkiaSharp.SKAlphaType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<param name="alpha">The alpha type of the texture.</param>
|
|
<summary>Creates a new image from the specified texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc,SkiaSharp.SKAlphaType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing OpenGL texture.</param>
|
|
<param name="alpha">The alpha type of the texture.</param>
|
|
<summary>Creates a new image from the specified OpenGL texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc,SkiaSharp.SKAlphaType,SkiaSharp.SKImageTextureReleaseDelegate)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<param name="alpha">The alpha type of the texture.</param>
|
|
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
|
|
<summary>Creates a new image from the specified texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc,SkiaSharp.SKAlphaType,SkiaSharp.SKImageTextureReleaseDelegate)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing OpenGL texture.</param>
|
|
<param name="alpha">The alpha type of the texture.</param>
|
|
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
|
|
<summary>Creates a new image from the specified OpenGL texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<param name="alpha">The transparency mode to use for the image.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc,SkiaSharp.SKAlphaType,SkiaSharp.SKImageTextureReleaseDelegate,System.Object)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<param name="alpha">The alpha type of the texture.</param>
|
|
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
|
|
<param name="releaseContext">The user data to use when invoking the delegate.</param>
|
|
<summary>Creates a new image from the specified texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc,SkiaSharp.SKAlphaType,SkiaSharp.SKImageTextureReleaseDelegate,System.Object)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing OpenGL texture.</param>
|
|
<param name="alpha">The alpha type of the texture.</param>
|
|
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
|
|
<param name="releaseContext">The user data to use when invoking the delegate.</param>
|
|
<summary>Creates a new image from the specified OpenGL texture descriptor.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified descriptor is unsupported</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="alpha">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<param name="alpha">The transparency mode to use for the image.</param>
|
|
<param name="colorspace">The colorspace to use for the image.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="alpha">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace,SkiaSharp.SKImageTextureReleaseDelegate)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<param name="alpha">The transparency mode to use for the image.</param>
|
|
<param name="colorspace">The colorspace to use for the image.</param>
|
|
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace,SkiaSharp.SKImageTextureReleaseDelegate)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="alpha">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="releaseProc">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace,SkiaSharp.SKImageTextureReleaseDelegate,System.Object)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing backend texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the image.</param>
|
|
<param name="alpha">The transparency mode to use for the image.</param>
|
|
<param name="colorspace">The colorspace to use for the image.</param>
|
|
<param name="releaseProc">The delegate to invoke when the image is about to be destroyed.</param>
|
|
<param name="releaseContext">The user data to use when invoking the delegate.</param>
|
|
<summary>Creates a new image from the specified texture.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if the specified texture is unsupported</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.FromTexture(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace,SkiaSharp.SKImageTextureReleaseDelegate,System.Object)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="alpha">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="releaseProc">To be added.</param>
|
|
<param name="releaseContext">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.Height">
|
|
<summary>Gets the image height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.Info">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.IsAlphaOnly">
|
|
<summary>Gets a value indicating whether the image will be drawn as a mask, with no intrinsic color of its own</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.IsLazyGenerated">
|
|
<summary>Gets a value indicating whether the image is backed by an image-generator or other source that creates (and caches) its pixels / texture on-demand.</summary>
|
|
<value />
|
|
<remarks>If this method returns <see langword="false" />, then <see cref="M:SkiaSharp.SKImage.PeekPixels" /> will return <see langword="null" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.IsTextureBacked">
|
|
<summary>Gets a value indicating whether the image is texture backed.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.IsValid(SkiaSharp.GRContext)">
|
|
<param name="context">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.IsValid(SkiaSharp.GRRecordingContext)">
|
|
<param name="context">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.PeekPixels">
|
|
<summary>Returns the pixmap if the image is raster-based.</summary>
|
|
<returns>Returns the pixmap, or <see langword="null" /> if the image does not have access to pixel data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.PeekPixels(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixmap to receive the pixel information.</param>
|
|
<summary>Returns the pixmap if the image is raster-based.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if the image does not have access to pixel data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ReadPixels(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ReadPixels(SkiaSharp.SKImageInfo,System.IntPtr)">
|
|
<param name="dstInfo">To be added.</param>
|
|
<param name="dstPixels">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ReadPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)">
|
|
<param name="dstInfo">To be added.</param>
|
|
<param name="dstPixels">To be added.</param>
|
|
<param name="dstRowBytes">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ReadPixels(SkiaSharp.SKPixmap,System.Int32,System.Int32)">
|
|
<param name="pixmap">The pixmap to read the pixel data into.</param>
|
|
<param name="srcX">The source x-coordinate to start reading from.</param>
|
|
<param name="srcY">The source y-coordinate to start reading from.</param>
|
|
<summary>Copies the pixels from the image into the specified buffer.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks>This method may return <see langword="false" /> if the source rectangle [<paramref name="srcX" />, <paramref name="srcY" />, dst.Info.Width, dst.Info.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ReadPixels(SkiaSharp.SKPixmap,System.Int32,System.Int32,SkiaSharp.SKImageCachingHint)">
|
|
<param name="pixmap">The pixmap to read the pixel data into.</param>
|
|
<param name="srcX">The source x-coordinate to start reading from.</param>
|
|
<param name="srcY">The source y-coordinate to start reading from.</param>
|
|
<param name="cachingHint">Whether or not to cache intermediate results.</param>
|
|
<summary>Copies the pixels from the image into the specified buffer.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks>This method may return <see langword="false" /> if the source rectangle [<paramref name="srcX" />, <paramref name="srcY" />, dst.Info.Width, dst.Info.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ReadPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,System.Int32,System.Int32)">
|
|
<param name="dstInfo">The image information describing the destination pixel buffer.</param>
|
|
<param name="dstPixels">The pixel buffer to read the pixel data into.</param>
|
|
<param name="dstRowBytes">The number of bytes in each row of in the destination buffer.</param>
|
|
<param name="srcX">The source x-coordinate to start reading from.</param>
|
|
<param name="srcY">The source y-coordinate to start reading from.</param>
|
|
<summary>Copies the pixels from the image into the specified buffer.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks>This method may return <see langword="false" /> if the source rectangle [<paramref name="srcX" />, <paramref name="srcY" />, dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ReadPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,System.Int32,System.Int32,SkiaSharp.SKImageCachingHint)">
|
|
<param name="dstInfo">The image information describing the destination pixel buffer.</param>
|
|
<param name="dstPixels">The pixel buffer to read the pixel data into.</param>
|
|
<param name="dstRowBytes">The number of bytes in each row of in the destination buffer.</param>
|
|
<param name="srcX">The source x-coordinate to start reading from.</param>
|
|
<param name="srcY">The source y-coordinate to start reading from.</param>
|
|
<param name="cachingHint">Whether or not to cache intermediate results.</param>
|
|
<summary>Copies the pixels from the image into the specified buffer.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks>This method may return <see langword="false" /> if the source rectangle [<paramref name="srcX" />, <paramref name="srcY" />, dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ScalePixels(SkiaSharp.SKPixmap,SkiaSharp.SKFilterQuality)">
|
|
<param name="dst">The pixmap describing the destination pixel buffer.</param>
|
|
<param name="quality">The quality of scaling to use.</param>
|
|
<summary>Copies the pixels from this image into the destination pixmap, scaling the image if the dimensions differ.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if the color type/alpha type could not be converted to the destination types.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ScalePixels(SkiaSharp.SKPixmap,SkiaSharp.SKFilterQuality,SkiaSharp.SKImageCachingHint)">
|
|
<param name="dst">The pixmap describing the destination pixel buffer.</param>
|
|
<param name="quality">The quality of scaling to use.</param>
|
|
<param name="cachingHint">Whether or not to cache intermediate results.</param>
|
|
<summary>Copies the pixels from this image into the destination pixmap, scaling the image if the dimensions differ.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if the color type/alpha type could not be converted to the destination types.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.Subset(SkiaSharp.SKRectI)">
|
|
<param name="subset">The rectangle indicating the subset to obtain.</param>
|
|
<summary>Returns a new image that is a subset of this image.</summary>
|
|
<returns>Returns the new image, or <see langword="null" /> if there was an error or the rectangle does not intersect the image.</returns>
|
|
<remarks>The underlying implementation may share the pixels, or it may make a copy.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ToRasterImage">
|
|
<summary>Returns a raster-based image of the current image.</summary>
|
|
<returns>Returns a raster-based copy of a texture image, or the same image if it already raster-based.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ToRasterImage(System.Boolean)">
|
|
<param name="ensurePixelData">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ToShader">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ToShader(SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode)">
|
|
<param name="tileX">The method in which to tile along the x-axis.</param>
|
|
<param name="tileY">The method in which to tile along the y-axis.</param>
|
|
<summary>Creates a new bitmap shader from the current image.</summary>
|
|
<returns>Returns a new bitmap shader that will draw the current image.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ToShader(SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="tileX">The method in which to tile along the x-axis.</param>
|
|
<param name="tileY">The method in which to tile along the y-axis.</param>
|
|
<param name="localMatrix">The local matrix to use with the shader.</param>
|
|
<summary>Creates a new bitmap shader from the current image.</summary>
|
|
<returns>Returns a new bitmap shader that will draw the current image.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ToTextureImage(SkiaSharp.GRContext)">
|
|
<param name="context">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ToTextureImage(SkiaSharp.GRContext,SkiaSharp.SKColorSpace)">
|
|
<param name="context">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImage.ToTextureImage(SkiaSharp.GRContext,System.Boolean)">
|
|
<param name="context">To be added.</param>
|
|
<param name="mipmapped">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.UniqueId">
|
|
<summary>Gets the unique ID associated with the image.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImage.Width">
|
|
<summary>Gets the image width.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKImageCachingHint">
|
|
<summary>Hints to image calls where the system might cache computed intermediates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKImageCachingHint.Allow">
|
|
<summary>Use the system's default behaviour.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKImageCachingHint.Disallow">
|
|
<summary>Caching should be avoided</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKImageFilter">
|
|
<summary>Image filters for use with the <see cref="P:SkiaSharp.SKPaint.ImageFilter" /> property of a <see cref="T:SkiaSharp.SKPaint" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateAlphaThreshold(SkiaSharp.SKRectI,System.Single,System.Single,SkiaSharp.SKImageFilter)">
|
|
<param name="region">The region to sample.</param>
|
|
<param name="innerThreshold">The minimum alpha for pixels within the region.</param>
|
|
<param name="outerThreshold">The maximum alpha for pixels outside the region.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<summary>Creates an image filter that samples a region.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks>If the sample is inside the region the alpha of the image is boosted up to a threshold value. If it is outside the region then the alpha is decreased to the threshold value. The (0, 0) point of the region corresponds to the upper left corner of the source image.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateAlphaThreshold(SkiaSharp.SKRegion,System.Single,System.Single,SkiaSharp.SKImageFilter)">
|
|
<param name="region">The region to sample.</param>
|
|
<param name="innerThreshold">The minimum alpha for pixels within the region.</param>
|
|
<param name="outerThreshold">The maximum alpha for pixels outside the region.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<summary>Creates an image filter that samples a region.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks>If the sample is inside the region the alpha of the image is boosted up to a threshold value. If it is outside the region then the alpha is decreased to the threshold value. The (0, 0) point of the region corresponds to the upper left corner of the source image.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateArithmetic(System.Single,System.Single,System.Single,System.Single,System.Boolean,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="k1">The k1 constant value.</param>
|
|
<param name="k2">The k2 constant value.</param>
|
|
<param name="k3">The k3 constant value.</param>
|
|
<param name="k4">The k4 constant value.</param>
|
|
<param name="enforcePMColor">Whether or not premultiplied colors are enforced.</param>
|
|
<param name="background">The background image filter to use. If this is null, then the source bitmap is used.</param>
|
|
<param name="foreground">The foreground image filter to use. If this is null, then the source bitmap is used.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies the specified arithmetic blend.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateBlendMode(SkiaSharp.SKBlendMode,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="mode">The blend mode.</param>
|
|
<param name="background">The background filter.</param>
|
|
<param name="foreground">The foreground filter.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a blend mode.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateBlur(System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="sigmaX">The standard deviation of the Gaussian blur to apply (greater than 0) in the horizontal direction.</param>
|
|
<param name="sigmaY">The standard deviation of the Gaussian blur to apply (greater than 0) in the vertical direction.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a blur.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateBlur(System.Single,System.Single,SkiaSharp.SKShaderTileMode,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="sigmaX">To be added.</param>
|
|
<param name="sigmaY">To be added.</param>
|
|
<param name="tileMode">To be added.</param>
|
|
<param name="input">To be added.</param>
|
|
<param name="cropRect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateColorFilter(SkiaSharp.SKColorFilter,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="cf">The color filter to use.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a color filter.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateCompose(SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter)">
|
|
<param name="outer">The outer (second) filter to apply.</param>
|
|
<param name="inner">The inner (first) filter to apply.</param>
|
|
<summary>Creates an image filter, whose effect is to first apply the inner filter and then apply the outer filter to the result of the inner.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateDilate(System.Int32,System.Int32,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="radiusX">The amount of dilation in the x-direction.</param>
|
|
<param name="radiusY">The amount of dilation in the y-direction.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a dilation to pixels of a bitmap.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateDilate(System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="radiusX">To be added.</param>
|
|
<param name="radiusY">To be added.</param>
|
|
<param name="input">To be added.</param>
|
|
<param name="cropRect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateDisplacementMapEffect(SkiaSharp.SKColorChannel,SkiaSharp.SKColorChannel,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="xChannelSelector">To be added.</param>
|
|
<param name="yChannelSelector">To be added.</param>
|
|
<param name="scale">To be added.</param>
|
|
<param name="displacement">To be added.</param>
|
|
<param name="input">To be added.</param>
|
|
<param name="cropRect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateDisplacementMapEffect(SkiaSharp.SKDisplacementMapEffectChannelSelectorType,SkiaSharp.SKDisplacementMapEffectChannelSelectorType,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="xChannelSelector">The channel in the x-direction to select for displacement.</param>
|
|
<param name="yChannelSelector">The channel in the y-direction to select for displacement.</param>
|
|
<param name="scale">The amount to displace by.</param>
|
|
<param name="displacement">The image filter to apply the displacement to.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a displacement map.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateDistantLitDiffuse(SkiaSharp.SKPoint3,SkiaSharp.SKColor,System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="direction">The direction of the light.</param>
|
|
<param name="lightColor">The color of the light.</param>
|
|
<param name="surfaceScale">The surface height to use.</param>
|
|
<param name="kd">The diffuse lighting constant.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a distant diffuse lighting.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateDistantLitSpecular(SkiaSharp.SKPoint3,SkiaSharp.SKColor,System.Single,System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="direction">The direction of the light.</param>
|
|
<param name="lightColor">The color of the light.</param>
|
|
<param name="surfaceScale">The surface height to use.</param>
|
|
<param name="ks">The specular lighting constant.</param>
|
|
<param name="shininess">The shininess or specular exponent.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a distant specular lighting.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateDropShadow(System.Single,System.Single,System.Single,System.Single,SkiaSharp.SKColor,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="dx">To be added.</param>
|
|
<param name="dy">To be added.</param>
|
|
<param name="sigmaX">To be added.</param>
|
|
<param name="sigmaY">To be added.</param>
|
|
<param name="color">To be added.</param>
|
|
<param name="input">To be added.</param>
|
|
<param name="cropRect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateDropShadow(System.Single,System.Single,System.Single,System.Single,SkiaSharp.SKColor,SkiaSharp.SKDropShadowImageFilterShadowMode,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="dx">The shadow offset in the x-direction.</param>
|
|
<param name="dy">The shadow offset in the y-direction.</param>
|
|
<param name="sigmaX">The amount to blur in the x-direction.</param>
|
|
<param name="sigmaY">The amount to blur in the y-direction.</param>
|
|
<param name="color">The shadow color.</param>
|
|
<param name="shadowMode">The shadow mode.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a drop shadow.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateDropShadowOnly(System.Single,System.Single,System.Single,System.Single,SkiaSharp.SKColor,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="dx">To be added.</param>
|
|
<param name="dy">To be added.</param>
|
|
<param name="sigmaX">To be added.</param>
|
|
<param name="sigmaY">To be added.</param>
|
|
<param name="color">To be added.</param>
|
|
<param name="input">To be added.</param>
|
|
<param name="cropRect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateErode(System.Int32,System.Int32,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="radiusX">The amount to erode in the x-direction.</param>
|
|
<param name="radiusY">The amount to erode in the y-direction.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that erodes the pixels of a bitmap.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateErode(System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="radiusX">To be added.</param>
|
|
<param name="radiusY">To be added.</param>
|
|
<param name="input">To be added.</param>
|
|
<param name="cropRect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateImage(SkiaSharp.SKImage)">
|
|
<param name="image">The image to draw.</param>
|
|
<summary>Creates an image filter that draws an image.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateImage(SkiaSharp.SKImage,SkiaSharp.SKRect,SkiaSharp.SKRect,SkiaSharp.SKFilterQuality)">
|
|
<param name="image">The image to draw.</param>
|
|
<param name="src">The rectangle of the source image to draw.</param>
|
|
<param name="dst">The rectangle of the destination area.</param>
|
|
<param name="filterQuality">The filter quality.</param>
|
|
<summary>Creates an image filter that draws an image.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateMagnifier(SkiaSharp.SKRect,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="src">The rectangle area to magnify.</param>
|
|
<param name="inset">The amount of magnification to apply.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that magnifies an area of a bitmap.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateMatrix(SkiaSharp.SKMatrix,SkiaSharp.SKFilterQuality,SkiaSharp.SKImageFilter)">
|
|
<param name="matrix">The transformation matrix.</param>
|
|
<param name="quality">The quality.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<summary>Creates an image filter that applies a transformation matrix.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateMatrixConvolution(SkiaSharp.SKSizeI,System.Single[],System.Single,System.Single,SkiaSharp.SKPointI,SkiaSharp.SKMatrixConvolutionTileMode,System.Boolean,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="kernelSize">The kernel size in pixels, in each dimension (N by M).</param>
|
|
<param name="kernel">The image processing kernel, with N * M elements in row order.</param>
|
|
<param name="gain">A scale factor applied to each pixel after convolution.</param>
|
|
<param name="bias">A bias factor added to each pixel after convolution.</param>
|
|
<param name="kernelOffset">An offset applied to each pixel coordinate before convolution.</param>
|
|
<param name="tileMode">How accesses outside the image are treated.</param>
|
|
<param name="convolveAlpha">Whether or not all channels are convolved, or just the RGB channels.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image that filter applies an NxM image processing kernel.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateMatrixConvolution(SkiaSharp.SKSizeI,System.Single[],System.Single,System.Single,SkiaSharp.SKPointI,SkiaSharp.SKShaderTileMode,System.Boolean,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="kernelSize">To be added.</param>
|
|
<param name="kernel">To be added.</param>
|
|
<param name="gain">To be added.</param>
|
|
<param name="bias">To be added.</param>
|
|
<param name="kernelOffset">To be added.</param>
|
|
<param name="tileMode">To be added.</param>
|
|
<param name="convolveAlpha">To be added.</param>
|
|
<param name="input">To be added.</param>
|
|
<param name="cropRect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateMerge(SkiaSharp.SKImageFilter[],SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="filters">The image filters to merge.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that merges a set of image filters.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateMerge(SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="first">The first image filter to merge.</param>
|
|
<param name="second">The second image filter to merge.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that merges two image filters.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateMerge(SkiaSharp.SKImageFilter[],SkiaSharp.SKBlendMode[],SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="filters">The image filters to merge.</param>
|
|
<param name="modes">The blend modes to merge the filters with.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that merges a set of image filters using blend modes.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateMerge(SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter,SkiaSharp.SKBlendMode,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="first">The first image filter to merge.</param>
|
|
<param name="second">The second image filter to merge.</param>
|
|
<param name="mode">The blend mode to merge the filters with.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that merges two image filters using a blend mode.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateOffset(System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="dx">The amount to offset in the x-direction.</param>
|
|
<param name="dy">The amount to offset in the y-direction.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that translates the bitmap that is drawn.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreatePaint(SkiaSharp.SKPaint,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="paint">The paint to draw.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that draws a paint.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreatePicture(SkiaSharp.SKPicture)">
|
|
<param name="picture">The picture to draw.</param>
|
|
<summary>Creates an image filter that draws a picture.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreatePicture(SkiaSharp.SKPicture,SkiaSharp.SKRect)">
|
|
<param name="picture">The picture to draw.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that draws a picture.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreatePictureForLocalspace(SkiaSharp.SKPicture,SkiaSharp.SKRect,SkiaSharp.SKFilterQuality)">
|
|
<param name="picture">The picture to draw.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<param name="filterQuality">The quality.</param>
|
|
<summary>Creates an image filter that draws a picture at a resolution that matches the local coordinate space.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreatePointLitDiffuse(SkiaSharp.SKPoint3,SkiaSharp.SKColor,System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="location">The location of the light.</param>
|
|
<param name="lightColor">The color of the light.</param>
|
|
<param name="surfaceScale">The surface height to use.</param>
|
|
<param name="kd">The diffuse lighting constant.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a point diffuse lighting.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreatePointLitSpecular(SkiaSharp.SKPoint3,SkiaSharp.SKColor,System.Single,System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="location">The location of the light.</param>
|
|
<param name="lightColor">The color of the light.</param>
|
|
<param name="surfaceScale">The surface height to use.</param>
|
|
<param name="ks">The specular lighting constant.</param>
|
|
<param name="shininess">The shininess or specular exponent.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a point specular lighting.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateSpotLitDiffuse(SkiaSharp.SKPoint3,SkiaSharp.SKPoint3,System.Single,System.Single,SkiaSharp.SKColor,System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="location">The location of the light.</param>
|
|
<param name="target">The target location of the light.</param>
|
|
<param name="specularExponent">The specular exponent.</param>
|
|
<param name="cutoffAngle">The cutoff angle of the spotlight.</param>
|
|
<param name="lightColor">The color of the light.</param>
|
|
<param name="surfaceScale">The surface height to use.</param>
|
|
<param name="kd">The diffuse lighting constant.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a spot diffuse lighting.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateSpotLitSpecular(SkiaSharp.SKPoint3,SkiaSharp.SKPoint3,System.Single,System.Single,SkiaSharp.SKColor,System.Single,System.Single,System.Single,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter+CropRect)">
|
|
<param name="location">The location of the light.</param>
|
|
<param name="target">The target location of the light.</param>
|
|
<param name="specularExponent">The specular exponent.</param>
|
|
<param name="cutoffAngle">The cutoff angle of the spotlight.</param>
|
|
<param name="lightColor">The color of the light.</param>
|
|
<param name="surfaceScale">The surface height to use.</param>
|
|
<param name="ks">The specular lighting constant.</param>
|
|
<param name="shininess">The shininess or specular exponent.</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<param name="cropRect">The rectangle to which the output processing will be limited.</param>
|
|
<summary>Creates an image filter that applies a spot specular lighting.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.CreateTile(SkiaSharp.SKRect,SkiaSharp.SKRect,SkiaSharp.SKImageFilter)">
|
|
<param name="src">The pixels to tile.</param>
|
|
<param name="dst">The pixels where the tiles are drawn</param>
|
|
<param name="input">The input filter to use.</param>
|
|
<summary>Creates an image filter that tiles the image being drawn.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKImageFilter" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKImageFilter" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKImageFilter+CropRect">
|
|
<summary>The rectangle to which the output processing of an <see cref="T:SkiaSharp.SKImageFilter" /> will be limited.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKImageFilter+CropRect">
|
|
<summary>Creates an empty crop rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKImageFilter+CropRect(SkiaSharp.SKRect,SkiaSharp.SKCropRectFlags)">
|
|
<param name="rect">The rectangle to crop to.</param>
|
|
<param name="flags">The edges that are specified by the rectangle.</param>
|
|
<summary>Creates a crop rectangle with the specified edges.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter+CropRect.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKImageFilter.CropRect" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKImageFilter.CropRect" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageFilter+CropRect.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageFilter+CropRect.Flags">
|
|
<summary>Gets the edges that are specified by the rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageFilter+CropRect.Rect">
|
|
<summary>Gets rectangle to crop to.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKImageInfo">
|
|
<summary>Describe an image's dimensions and pixel type.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKImageInfo(System.Int32,System.Int32)">
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKImageInfo" /> with the specified width and height.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKImageInfo(System.Int32,System.Int32,SkiaSharp.SKColorType)">
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<param name="colorType">The color type.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKImageInfo" /> with the specified width, height and color type.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKImageInfo(System.Int32,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType)">
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<param name="colorType">The color type.</param>
|
|
<param name="alphaType">The alpha/transparency type.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKImageInfo" /> with the specified width, height, color type and transparency type.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKImageInfo(System.Int32,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKColorSpace)">
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<param name="colorType">The color type.</param>
|
|
<param name="alphaType">The alpha/transparency type.</param>
|
|
<param name="colorspace">The color space.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKImageInfo" /> with the specified width, height, color type, transparency type and color space.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.AlphaType">
|
|
<summary>Gets the transparency type for the image info.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.BitsPerPixel">
|
|
<summary>Gets the number of bits used per pixel.</summary>
|
|
<value />
|
|
<remarks>This is equivalent to multiplying the <see cref="P:SkiaSharp.SKImageInfo.BytesPerPixel" /> by 8 (the number of bits in a byte).</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.BytesPerPixel">
|
|
<summary>Gets the number of bytes used per pixel.</summary>
|
|
<value />
|
|
<remarks>This is calculated from the <see cref="P:SkiaSharp.SKImageInfo.ColorType" />. If the color type is <see cref="F:SkiaSharp.SKColorType.Unknown" />, then the value will be 0.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.BytesSize">
|
|
<summary>Gets the total number of bytes needed to store the bitmap data.</summary>
|
|
<value />
|
|
<remarks>This is calculated as: <see cref="P:SkiaSharp.SKImageInfo.Width" /> * <see cref="P:SkiaSharp.SKImageInfo.Height" /> * <see cref="P:SkiaSharp.SKImageInfo.BytesPerPixel" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.BytesSize64">
|
|
<summary>Gets the total number of bytes needed to store the bitmap data as a 64-bit integer.</summary>
|
|
<value />
|
|
<remarks>This is calculated as: <see cref="P:SkiaSharp.SKImageInfo.Width" /> * <see cref="P:SkiaSharp.SKImageInfo.Height" /> * <see cref="P:SkiaSharp.SKImageInfo.BytesPerPixel" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.ColorSpace">
|
|
<summary>Gets or sets the color space.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.ColorType">
|
|
<summary>Gets or sets the color type.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKImageInfo.Empty">
|
|
<summary>An empty <see cref="T:SkiaSharp.SKImageInfo" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.Equals(SkiaSharp.SKImageInfo)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.Height">
|
|
<summary>Gets or sets the height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.IsEmpty">
|
|
<summary>Gets a value indicating whether the width or height are less or equal than zero.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.IsOpaque">
|
|
<summary>Gets a value indicating whether the configured alpha type is opaque.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.op_Equality(SkiaSharp.SKImageInfo,SkiaSharp.SKImageInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.op_Inequality(SkiaSharp.SKImageInfo,SkiaSharp.SKImageInfo)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKImageInfo.PlatformColorAlphaShift">
|
|
<summary>The number of bits to shift left for the alpha color component.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKImageInfo.PlatformColorBlueShift">
|
|
<summary>The number of bits to shift left for the blue color component.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKImageInfo.PlatformColorGreenShift">
|
|
<summary>The number of bits to shift left for the green color component.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKImageInfo.PlatformColorRedShift">
|
|
<summary>The number of bits to shift left for the red color component.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKImageInfo.PlatformColorType">
|
|
<summary>The current 32-bit color for the current platform.</summary>
|
|
<remarks>On Windows, it is typically <see cref="F:SkiaSharp.SKColorType.Bgra8888" />, and on Unix-based systems (macOS, Linux) it is typically <see cref="F:SkiaSharp.SKColorType.Rgba8888" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.Rect">
|
|
<summary>Gets a rectangle with the current width and height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.RowBytes">
|
|
<summary>Gets the number of bytes per row.</summary>
|
|
<value />
|
|
<remarks>This is calculated as: <see cref="P:SkiaSharp.SKImageInfo.Width" /> * <see cref="P:SkiaSharp.SKImageInfo.BytesPerPixel" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.RowBytes64">
|
|
<summary>Gets the number of bytes per row as a 64-bit integer.</summary>
|
|
<value />
|
|
<remarks>This is calculated as: <see cref="P:SkiaSharp.SKImageInfo.Width" /> * <see cref="P:SkiaSharp.SKImageInfo.BytesPerPixel" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.Size">
|
|
<summary>Gets the current size of the image.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKImageInfo.Width">
|
|
<summary>Gets or sets the width.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.WithAlphaType(SkiaSharp.SKAlphaType)">
|
|
<param name="newAlphaType">The alpha/transparency type.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKImageInfo" /> with the same properties as this <see cref="T:SkiaSharp.SKImageInfo" />, but with the specified transparency type.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageInfo" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.WithColorSpace(SkiaSharp.SKColorSpace)">
|
|
<param name="newColorSpace">The color space.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKImageInfo" /> with the same properties as this <see cref="T:SkiaSharp.SKImageInfo" />, but with the specified color space.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageInfo" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.WithColorType(SkiaSharp.SKColorType)">
|
|
<param name="newColorType">The color type.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKImageInfo" /> with the same properties as this <see cref="T:SkiaSharp.SKImageInfo" />, but with the specified color type.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageInfo" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.WithSize(SkiaSharp.SKSizeI)">
|
|
<param name="size">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKImageInfo.WithSize(System.Int32,System.Int32)">
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKImageInfo" /> with the same properties as this <see cref="T:SkiaSharp.SKImageInfo" />, but with the specified dimensions.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKImageInfo" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKImageRasterReleaseDelegate">
|
|
<param name="pixels">The memory address of the pixels being released.</param>
|
|
<param name="context">The user data that was provided when creating the image.</param>
|
|
<summary>The delegate that is used when releasing the memory for a raster-based image.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKImageTextureReleaseDelegate">
|
|
<param name="context">The context of the image.</param>
|
|
<summary>The delegate that is used when releasing the memory for a texture-based image.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKJpegEncoderAlphaOption">
|
|
<summary>Various options to control how alpha should be handled.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKJpegEncoderAlphaOption.BlendOnBlack">
|
|
<summary>Blend the pixels onto a black background before encoding.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKJpegEncoderAlphaOption.Ignore">
|
|
<summary>Ignore the alpha channel and treat the image as opaque.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKJpegEncoderDownsample">
|
|
<summary>Various options for the downsampling factor of the U and V components.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKJpegEncoderDownsample.Downsample420">
|
|
<summary>Reduction by a factor of two in both the horizontal and vertical directions.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKJpegEncoderDownsample.Downsample422">
|
|
<summary>Reduction by a factor of two in the horizontal direction.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKJpegEncoderDownsample.Downsample444">
|
|
<summary>No downsampling.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKJpegEncoderOptions">
|
|
<summary>Options to control the JPEG encoding.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKJpegEncoderOptions(System.Int32,SkiaSharp.SKJpegEncoderDownsample,SkiaSharp.SKJpegEncoderAlphaOption)">
|
|
<param name="quality">The quality of the encoding in the range 0 to 100.</param>
|
|
<param name="downsample">The downsampling factor for the U and V components.</param>
|
|
<param name="alphaOption">The value to control how alpha is handled.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKJpegEncoderOptions" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKJpegEncoderOptions(System.Int32,SkiaSharp.SKJpegEncoderDownsample,SkiaSharp.SKJpegEncoderAlphaOption,SkiaSharp.SKTransferFunctionBehavior)">
|
|
<param name="quality">The quality of the encoding in the range 0 to 100.</param>
|
|
<param name="downsample">The downsampling factor for the U and V components.</param>
|
|
<param name="alphaOption">The value to control how alpha is handled.</param>
|
|
<param name="blendBehavior">The behavior when blending alpha.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKJpegEncoderOptions" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKJpegEncoderOptions.AlphaOption">
|
|
<summary>Gets or sets the value to control how alpha is handled.</summary>
|
|
<value />
|
|
<remarks>JPEGs must be opaque, so this instructs the encoder on how to handle input images with alpha.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKJpegEncoderOptions.BlendBehavior">
|
|
<summary>Gets or sets the behavior when blending alpha.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKJpegEncoderOptions.Default">
|
|
<summary>Gets a new instance of <see cref="T:SkiaSharp.SKJpegEncoderOptions" /> with the values set to the defaults.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKJpegEncoderOptions.Downsample">
|
|
<summary>Gets or sets the downsampling factor for the U and V components.</summary>
|
|
<value />
|
|
<remarks>This is only meaningful if the image is not gray, since gray will not be encoded as YUV.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKJpegEncoderOptions.Equals(SkiaSharp.SKJpegEncoderOptions)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKJpegEncoderOptions.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKJpegEncoderOptions.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKJpegEncoderOptions.op_Equality(SkiaSharp.SKJpegEncoderOptions,SkiaSharp.SKJpegEncoderOptions)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKJpegEncoderOptions.op_Inequality(SkiaSharp.SKJpegEncoderOptions,SkiaSharp.SKJpegEncoderOptions)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKJpegEncoderOptions.Quality">
|
|
<summary>Gets or sets the quality of the encoding in the range 0 to 100.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKLattice">
|
|
<summary>Specifies coordinates to divide a bitmap into (<see cref="P:SkiaSharp.SKLattice.XDivs" /> * <see cref="P:SkiaSharp.SKLattice.YDivs" />) rectangles.</summary>
|
|
<remarks>If the lattice divs or bounds are invalid, the entire lattice structure will be ignored on the draw call.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKLattice.Bounds">
|
|
<summary>Gets or sets the optional source image bounds.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKLattice.Colors">
|
|
<summary>Gets or sets the array of fill types, one per rectangular grid entry.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKLattice.Equals(SkiaSharp.SKLattice)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKLattice.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKLattice.Flags">
|
|
<summary>Gets or sets the drawing options for each of the lattice rectangles.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKLattice.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKLattice.op_Equality(SkiaSharp.SKLattice,SkiaSharp.SKLattice)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKLattice.op_Inequality(SkiaSharp.SKLattice,SkiaSharp.SKLattice)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKLattice.RectTypes">
|
|
<summary>Gets or sets the color for each of the lattice rectangles.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKLattice.XDivs">
|
|
<summary>Gets or sets the x-coordinates for the lattice.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKLattice.YDivs">
|
|
<summary>Gets or sets the y-coordinates for the lattice.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKLatticeFlags">
|
|
<summary>Flags to control how the bitmap lattice is drawn.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKLatticeFlags.Default">
|
|
<summary>Draw the bitmap for the rectangle.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKLatticeFlags.Transparent">
|
|
<summary>Skip the drawing for the rectangle.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKLatticeRectType">
|
|
<summary>Optional setting per rectangular grid entry to make it transparent, or to fill the grid entry with a color.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKLatticeRectType.Default">
|
|
<summary>Draw the bitmap into the lattice rectangle.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKLatticeRectType.FixedColor">
|
|
<summary>Draw the associated <see cref="P:SkiaSharp.SKLattice.Colors" /> entry into the lattice rectangle.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKLatticeRectType.Transparent">
|
|
<summary>Skip the lattice rectangle (make it transparent).</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKManagedPixelSerializer">
|
|
<summary>Represents a mechanism for serializing pixels.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKManagedPixelSerializer">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKManagedPixelSerializer" /> with an empty buffer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedPixelSerializer.OnEncode(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixel data to encode.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKManagedPixelSerializer" /> types to encode the specified pixel data.</summary>
|
|
<returns>Returns the encoded pixel data, or <see langword="null" /> if the raw pixels should be used.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedPixelSerializer.OnUseEncodedData(System.IntPtr,System.IntPtr)">
|
|
<param name="data">The encoded data buffer.</param>
|
|
<param name="length">The length of the encoded data buffer.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKManagedPixelSerializer" /> types to determine whether the caller should use the specified encoded data instead of encoding a new version.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified encoded data should be used, otherwise <see langword="false" /> to serialize another version.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If this method returns `true`, then
|
|
<xref:SkiaSharp.SKPixelSerializer.Encode%2A> should not be called to encode
|
|
the source data.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKManagedStream">
|
|
<summary>Wraps a <see cref="T:System.IO.Stream" /> into a <see cref="T:SkiaSharp.SKStreamAsset" /> (a seekable, rewindable Skia stream)</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The following example shows how to wrap a <xref:System.IO.Stream> that
|
|
represents a stream into an embedded resource in an assembly and use it with
|
|
SkiaSharp APIs that use resources:
|
|
|
|
## Examples
|
|
|
|
```csharp
|
|
public static void BitmapShader (SKCanvas canvas, int width, int height)
|
|
{
|
|
var assembly = typeof(Demos).GetTypeInfo ().Assembly;
|
|
|
|
// load the image from the embedded resource stream
|
|
using (var resource = assembly.GetManifestResourceStream ("embedded.png"))
|
|
using (var stream = new SKManagedStream(resource))
|
|
using (var source = SKBitmap.Decode (stream)) {
|
|
var matrix = SKMatrix.MakeRotation (30.0f);
|
|
using (var shader = SKShader.CreateBitmap (source, SKShaderTileMode.Repeat, SKShaderTileMode.Repeat, matrix))
|
|
using (var paint = new SKPaint ()) {
|
|
paint.IsAntialias = true;
|
|
paint.Shader = shader;
|
|
|
|
// tile the bitmap
|
|
canvas.Clear (SKColors.White);
|
|
canvas.DrawPaint (paint);
|
|
}
|
|
}
|
|
}
|
|
```
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKManagedStream(System.IO.Stream)">
|
|
<param name="managedStream">The managed stream.</param>
|
|
<summary>Creates a new read-only stream from a <see cref="T:System.IO.Stream" />.</summary>
|
|
<remarks>The underlying stream is not disposed when this object is disposed.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKManagedStream(System.IO.Stream,System.Boolean)">
|
|
<param name="managedStream">The managed stream.</param>
|
|
<param name="disposeManagedStream">If this is set to <see langword="true" />, the provided <see langword="managedStream" /> will be disposed when this instance is disposed.</param>
|
|
<summary>Creates a new read-only stream from a <see cref="T:System.IO.Stream" />, can optionally dispose the provided stream when this stream is disposed.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.CopyTo(SkiaSharp.SKWStream)">
|
|
<param name="destination">The destination stream.</param>
|
|
<summary>Copy the contents of this stream into the destination stream.</summary>
|
|
<returns>Returns the number of bytes that were copied.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKManagedStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKManagedStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.DisposeManaged">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKNativeObject" /> types to destroy any managed objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnCreateNew">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to copy the current stream.</summary>
|
|
<returns>Returns a pointer to the new <see cref="T:SkiaSharp.SKStreamAsset" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnDuplicate">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to duplicate the current stream.</summary>
|
|
<returns>Returns a pointer to the new <see cref="T:SkiaSharp.SKStreamAsset" /> instance.</returns>
|
|
<remarks>After the stream has been duplicated, the new stream must set it's position to the start.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnFork">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to fork the current stream.</summary>
|
|
<returns>Returns a pointer to the new <see cref="T:SkiaSharp.SKStreamAsset" /> instance.</returns>
|
|
<remarks>After the stream has been duplicated, the new stream must set it's position to the same as this stream.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnGetLength">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to return the total length of the stream.</summary>
|
|
<returns>Returns the total length of the stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnGetPosition">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to get the current position in the stream</summary>
|
|
<returns>Returns the current position in the stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnHasLength">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to indicate whether this stream can report it's total length.</summary>
|
|
<returns>Returns a value indicating whether this stream can report it's total length.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnHasPosition">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to indicate whether this stream can report it's current position.</summary>
|
|
<returns>Returns a value indicating whether this stream can report it's current position.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnIsAtEnd">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to indicate whether all the bytes in the stream have been read.</summary>
|
|
<returns>Returns a value indicating whether all the bytes in the stream have been read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnMove(System.Int32)">
|
|
<param name="offset">The relative offset.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to seek to a relative offset.</summary>
|
|
<returns>Returns <see langword="true" /> if seeking is supported and the seek was successful, otherwise <see langword="false" />.</returns>
|
|
<remarks>If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnPeek(System.IntPtr,System.IntPtr)">
|
|
<param name="buffer">The buffer to read into.</param>
|
|
<param name="size">The number of bytes to read.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to copy the specified number of bytes into the specified buffer.</summary>
|
|
<returns>Returns the number of bytes actually peeked/copied.</returns>
|
|
<remarks>The stream's cursor must be returned to the position before this method was called.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnRead(System.IntPtr,System.IntPtr)">
|
|
<param name="buffer">The buffer to read into.</param>
|
|
<param name="size">The number of bytes to read.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to copy the specified number of bytes into the specified buffer.</summary>
|
|
<returns>Returns the number of bytes actually read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnRewind">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to rewind the current stream.</summary>
|
|
<returns>Returns <see langword="true" /> if the stream is known to be at the beginning after this call returns.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.OnSeek(System.IntPtr)">
|
|
<param name="position">The absolute position.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedStream" /> types to seek to an absolute position.</summary>
|
|
<returns>Returns <see langword="true" /> if seeking is supported and the seek was successful, otherwise <see langword="false" />.</returns>
|
|
<remarks>If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedStream.ToMemoryStream">
|
|
<summary>Copies the contents of this stream into a new memory stream.</summary>
|
|
<returns>Returns the new memory stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKManagedWStream">
|
|
<summary>Wraps a <see cref="T:System.IO.Stream" /> into a <see cref="T:SkiaSharp.SKWStream" /> (a writeable Skia stream)</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKManagedWStream(System.IO.Stream)">
|
|
<param name="managedStream">The managed stream.</param>
|
|
<summary>Creates a new writeable stream from a <see cref="T:System.IO.Stream" />.</summary>
|
|
<remarks>The underlying stream is not disposed when this object is disposed.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKManagedWStream(System.IO.Stream,System.Boolean)">
|
|
<param name="managedStream">The managed stream.</param>
|
|
<param name="disposeManagedStream">If this is set to <see langword="true" />, the provided <see langword="managedStream" /> will be disposed when this instance is disposed.</param>
|
|
<summary>Creates a new writeable stream from a <see cref="T:System.IO.Stream" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedWStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKManagedWStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKManagedWStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedWStream.DisposeManaged">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKNativeObject" /> types to destroy any managed objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedWStream.OnBytesWritten">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to specify the number of bytes currently written to the stream.</summary>
|
|
<returns>Returns the number of bytes currently written to the stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedWStream.OnFlush">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to flush the bytes to the underlying stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKManagedWStream.OnWrite(System.IntPtr,System.IntPtr)">
|
|
<param name="buffer">The buffer to copy into the underlying stream.</param>
|
|
<param name="size">The number of bytes to copy from the buffer.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to copy the specified number of bytes from the specified buffer into the underlying stream.</summary>
|
|
<returns>Returns <see langword="true" /> on success, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKMask">
|
|
<summary>A mask is used to describe alpha bitmaps, either 1-bit, 8-bit, or the 3-channel 3D format.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMask(SkiaSharp.SKRectI,System.UInt32,SkiaSharp.SKMaskFormat)">
|
|
<param name="bounds">The bounds of the mask in the image.</param>
|
|
<param name="rowBytes">The number of bytes per row.</param>
|
|
<param name="format">The format of the mask image.</param>
|
|
<summary>Creates an instance of <see cref="T:SkiaSharp.SKMask" /> with the specified configuration, but a null <see cref="P:SkiaSharp.SKMask.Image" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMask(System.IntPtr,SkiaSharp.SKRectI,System.UInt32,SkiaSharp.SKMaskFormat)">
|
|
<param name="image">The pointer to the image data to use as the mask.</param>
|
|
<param name="bounds">The bounds of the mask in the image.</param>
|
|
<param name="rowBytes">The number of bytes per row.</param>
|
|
<param name="format">The format of the mask image.</param>
|
|
<summary>Creates an instance of <see cref="T:SkiaSharp.SKMask" /> with the specified configuration.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.AllocateImage">
|
|
<summary>Allocates a memory block for the mask's image.</summary>
|
|
<returns>Returns the total size of the allocated memory.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.AllocateImage(System.Int64)">
|
|
<param name="size">The amount of memory to allocate.</param>
|
|
<summary>Allocates a memory block for a mask's image.</summary>
|
|
<returns>Returns a pointer to the allocated memory.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMask.Bounds">
|
|
<summary>Gets the bounds of the mask in the image.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.ComputeImageSize">
|
|
<summary>Calculates the byte size of the mask, assuming only 1 plane.</summary>
|
|
<returns>Returns the byte size of the mask.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Does not account for
|
|
<xref:SkiaSharp.SKMaskFormat.ThreeD?displayProperty=nameWithType>. For that,
|
|
use <xref:SkiaSharp.SKMask.ComputeTotalImageSize>.
|
|
|
|
If there is an overflow of 32bits, then returns 0.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.ComputeTotalImageSize">
|
|
<summary>Calculates the byte size of the mask, taking into account any extra planes (e.g. <see cref="F:SkiaSharp.SKMaskFormat.ThreeD" />).</summary>
|
|
<returns>Returns the byte size of the mask.</returns>
|
|
<remarks>If there is an overflow of 32bits, then returns 0.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.Create(System.Byte[],SkiaSharp.SKRectI,System.UInt32,SkiaSharp.SKMaskFormat)">
|
|
<param name="image">The image data to copy into the mask.</param>
|
|
<param name="bounds">The bounds of the mask in the image.</param>
|
|
<param name="rowBytes">The number of bytes per row.</param>
|
|
<param name="format">The format of the mask image.</param>
|
|
<summary>Creates an instance of <see cref="T:SkiaSharp.SKMask" /> with the specified configuration, and copies the image data.</summary>
|
|
<returns>Returns the instance of the mask.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.Create(System.ReadOnlySpan{System.Byte},SkiaSharp.SKRectI,System.UInt32,SkiaSharp.SKMaskFormat)">
|
|
<param name="image">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<param name="rowBytes">To be added.</param>
|
|
<param name="format">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.Equals(SkiaSharp.SKMask)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMask.Format">
|
|
<summary>Gets the format of the mask image.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.FreeImage">
|
|
<summary>De-allocate the mask's image data.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.FreeImage(System.IntPtr)">
|
|
<param name="image">The pointer to a mask's image data.</param>
|
|
<summary>De-allocate the specified mask image data.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.GetAddr(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate, which must be contained by the mask's bounds.</param>
|
|
<param name="y">The y-coordinate, which must be contained by the mask's bounds.</param>
|
|
<summary>Returns the address of the specified pixel, computing the pixel-size at runtime based on the mask format.</summary>
|
|
<returns>Returns the address of the specified pixel.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This will be slightly slower than using one of the routines where the format
|
|
is implied by the name (e.g. <xref:SkiaSharp.SKMask.GetAddr8%2A> or
|
|
<xref:SkiaSharp.SKMask.GetAddr32%2A>).
|
|
|
|
This should not be called with <xref:SkiaSharp.SKMaskFormat.BW>, as it will
|
|
give unspecified results.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.GetAddr1(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate, which must be contained by the mask's bounds.</param>
|
|
<param name="y">The y-coordinate, which must be contained by the mask's bounds.</param>
|
|
<summary>Returns the bit value of the specified specified pixel.</summary>
|
|
<returns>Returns the bit value of the specified specified pixel.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.GetAddr16(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate, which must be contained by the mask's bounds.</param>
|
|
<param name="y">The y-coordinate, which must be contained by the mask's bounds.</param>
|
|
<summary>Returns the 16-bit value of the specified specified pixel.</summary>
|
|
<returns>Returns the 16-bit value of the specified specified pixel.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.GetAddr32(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate, which must be contained by the mask's bounds.</param>
|
|
<param name="y">The y-coordinate, which must be contained by the mask's bounds.</param>
|
|
<summary>Returns the 32-bit value of the specified specified pixel.</summary>
|
|
<returns>Returns the 32-bit value of the specified specified pixel.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.GetAddr8(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate, which must be contained by the mask's bounds.</param>
|
|
<param name="y">The y-coordinate, which must be contained by the mask's bounds.</param>
|
|
<summary>Returns the 8-bit value of the specified specified pixel.</summary>
|
|
<returns>Returns the 8-bit value of the specified specified pixel.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.GetImageSpan">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMask.Image">
|
|
<summary>Get the pointer to the mask's image data location.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMask.IsEmpty">
|
|
<summary>Gets a value indicating whether the mask's bounds are empty.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.op_Equality(SkiaSharp.SKMask,SkiaSharp.SKMask)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMask.op_Inequality(SkiaSharp.SKMask,SkiaSharp.SKMask)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMask.RowBytes">
|
|
<summary>Gets the number of bytes per row.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKMaskFilter">
|
|
<summary>Mask filters perform transformations on an alpha-channel mask before drawing. A mask filter is set using the <see cref="P:SkiaSharp.SKPaint.MaskFilter" /> property on <see cref="T:SkiaSharp.SKPaint" /> type.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.ConvertRadiusToSigma(System.Single)">
|
|
<param name="radius">The radius.</param>
|
|
<summary>Converts from the (legacy) idea of specifying the blur "radius" to the standard notion of specifying its sigma.</summary>
|
|
<returns>The sigma.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.ConvertSigmaToRadius(System.Single)">
|
|
<param name="sigma">The sigma.</param>
|
|
<summary>Converts from the standard notion of specifying the blur sigma to the (legacy) idea of specifying its "radius".</summary>
|
|
<returns>The radius.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.CreateBlur(SkiaSharp.SKBlurStyle,System.Single)">
|
|
<param name="blurStyle">The style of blurring.</param>
|
|
<param name="sigma">The standard deviation (greater than 0) of the Gaussian blur to apply.</param>
|
|
<summary>Creates a mask filter that applies a blur.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.CreateBlur(SkiaSharp.SKBlurStyle,System.Single,SkiaSharp.SKBlurMaskFilterFlags)">
|
|
<param name="blurStyle">The style of blurring.</param>
|
|
<param name="sigma">The standard deviation (greater than 0) of the Gaussian blur to apply.</param>
|
|
<param name="flags">The flags to apply when blurring.</param>
|
|
<summary>Creates a mask filter that applies a blur.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.CreateBlur(SkiaSharp.SKBlurStyle,System.Single,SkiaSharp.SKRect)">
|
|
<param name="blurStyle">The style of blurring.</param>
|
|
<param name="sigma">The standard deviation (greater than 0) of the Gaussian blur to apply.</param>
|
|
<param name="occluder">The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object).</param>
|
|
<summary>Creates a mask filter that applies a blur.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.CreateBlur(SkiaSharp.SKBlurStyle,System.Single,System.Boolean)">
|
|
<param name="blurStyle">To be added.</param>
|
|
<param name="sigma">To be added.</param>
|
|
<param name="respectCTM">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.CreateBlur(SkiaSharp.SKBlurStyle,System.Single,SkiaSharp.SKRect,SkiaSharp.SKBlurMaskFilterFlags)">
|
|
<param name="blurStyle">The style of blurring.</param>
|
|
<param name="sigma">The standard deviation (greater than 0) of the Gaussian blur to apply.</param>
|
|
<param name="occluder">The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object).</param>
|
|
<param name="flags">The flags to apply when blurring.</param>
|
|
<summary>Creates a mask filter that applies a blur.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.CreateBlur(SkiaSharp.SKBlurStyle,System.Single,SkiaSharp.SKRect,System.Boolean)">
|
|
<param name="blurStyle">The style of blurring.</param>
|
|
<param name="sigma">The standard deviation (greater than 0) of the Gaussian blur to apply.</param>
|
|
<param name="occluder">The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object).</param>
|
|
<param name="respectCTM">Whether or not the blur's sigma is modified by the CTM.</param>
|
|
<summary>Creates a mask filter that applies a blur.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.CreateClip(System.Byte,System.Byte)">
|
|
<param name="min">The minimum alpha value.</param>
|
|
<param name="max">The maximum alpha value.</param>
|
|
<summary>Creates a mask filter that clips the alpha channel to the specified minimum and maximum alpha values.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.CreateGamma(System.Single)">
|
|
<param name="gamma">The gamma.</param>
|
|
<summary>Creates a mask filter that applies gamma.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.CreateTable(System.Byte[])">
|
|
<param name="table">The lookup table with exactly 256 elements.</param>
|
|
<summary>Creates a mask filter that applies a table lookup on each of the alpha values in the mask.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMaskFilter.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKMaskFilter" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKMaskFilter" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMaskFilter.TableMaxLength">
|
|
<summary>Gets the maximum number of colors in the color lookup table.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKMaskFormat">
|
|
<summary>Formats that indicate the memory format of the underlying image data of a <see cref="T:SkiaSharp.SKMask" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMaskFormat.A8">
|
|
<summary>8-bits per pixel mask (e.g. anti-aliasing).</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMaskFormat.Argb32">
|
|
<summary>Premultiplied color.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMaskFormat.BW">
|
|
<summary>1-bit per pixel mask (e.g. monochrome).</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMaskFormat.Lcd16">
|
|
<summary>565 alpha for RGB.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMaskFormat.Sdf">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMaskFormat.ThreeD">
|
|
<summary>3 8-bit per pixel planes: alpha, mul, add.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKMatrix">
|
|
<summary>A 3x3 transformation matrix with perspective.</summary>
|
|
<remarks>It extends the traditional 2D affine transformation matrix with three perspective components that allow simple 3D effects to be created with it. Those components must be manually set by using the <see cref="P:SkiaSharp.SKMatrix.Persp0" />, <see cref="P:SkiaSharp.SKMatrix.Persp1" />, <see cref="P:SkiaSharp.SKMatrix.Persp2" /> fields of the matrix.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMatrix(System.Single[])">
|
|
<param name="values">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMatrix(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="scaleX">The scaling in the x-direction.</param>
|
|
<param name="skewX">The skew in the x-direction.</param>
|
|
<param name="transX">The translation in the x-direction.</param>
|
|
<param name="skewY">The skew in the y-direction.</param>
|
|
<param name="scaleY">The scaling in the y-direction.</param>
|
|
<param name="transY">The translation in the y-direction.</param>
|
|
<param name="persp0">The x-perspective.</param>
|
|
<param name="persp1">The y-perspective.</param>
|
|
<param name="persp2">The z-perspective.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKMatrix" /> using the specified values.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.Concat(SkiaSharp.SKMatrix,SkiaSharp.SKMatrix)">
|
|
<param name="first">To be added.</param>
|
|
<param name="second">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.Concat(SkiaSharp.SKMatrix@,SkiaSharp.SKMatrix,SkiaSharp.SKMatrix)">
|
|
<param name="target">The result matrix value.</param>
|
|
<param name="first">The first matrix to concatenate.</param>
|
|
<param name="second">The second matrix to concatenate.</param>
|
|
<summary>Concatenates the specified matrices into the resulting target matrix.</summary>
|
|
<remarks>Either source matrices can also be the target matrix.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.Concat(SkiaSharp.SKMatrix@,SkiaSharp.SKMatrix@,SkiaSharp.SKMatrix@)">
|
|
<param name="target">The result matrix value.</param>
|
|
<param name="first">The first matrix to concatenate.</param>
|
|
<param name="second">The second matrix to concatenate.</param>
|
|
<summary>Concatenates the specified matrices into the resulting target matrix.</summary>
|
|
<remarks>Either source matrices can also be the target matrix.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateIdentity">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateRotation(System.Single)">
|
|
<param name="radians">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateRotation(System.Single,System.Single,System.Single)">
|
|
<param name="radians">To be added.</param>
|
|
<param name="pivotX">To be added.</param>
|
|
<param name="pivotY">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateRotationDegrees(System.Single)">
|
|
<param name="degrees">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateRotationDegrees(System.Single,System.Single,System.Single)">
|
|
<param name="degrees">To be added.</param>
|
|
<param name="pivotX">To be added.</param>
|
|
<param name="pivotY">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateScale(System.Single,System.Single)">
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateScale(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="pivotX">To be added.</param>
|
|
<param name="pivotY">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateScaleTranslation(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="sx">To be added.</param>
|
|
<param name="sy">To be added.</param>
|
|
<param name="tx">To be added.</param>
|
|
<param name="ty">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateSkew(System.Single,System.Single)">
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.CreateTranslation(System.Single,System.Single)">
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrix.Empty">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.Equals(SkiaSharp.SKMatrix)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.GetValues(System.Single[])">
|
|
<param name="values">The array to populate.</param>
|
|
<summary>Populates the specified array with the matrix values.</summary>
|
|
<remarks>The result will be the same as <see cref="P:SkiaSharp.SKMatrix.Values" />.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrix.Identity">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.Invert">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.IsIdentity">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.IsInvertible">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MakeIdentity">
|
|
<summary>Creates an identity matrix.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MakeRotation(System.Single)">
|
|
<param name="radians">The angle for the rotation, in radians.</param>
|
|
<summary>Creates a matrix that represents a specific rotation in radians.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MakeRotation(System.Single,System.Single,System.Single)">
|
|
<param name="radians">The angle for the rotation, in radians.</param>
|
|
<param name="pivotx">The x-coordinate for the rotation pivot.</param>
|
|
<param name="pivoty">The y-coordinate for the rotation pivot.</param>
|
|
<summary>Creates a matrix that represents a specific rotation in radians, around a pivot point.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MakeRotationDegrees(System.Single)">
|
|
<param name="degrees">The angle for the rotation, in degrees.</param>
|
|
<summary>Creates a matrix that represents a specific rotation in degrees.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MakeRotationDegrees(System.Single,System.Single,System.Single)">
|
|
<param name="degrees">The angle for the rotation, in degrees.</param>
|
|
<param name="pivotx">The x-coordinate for the rotation pivot.</param>
|
|
<param name="pivoty">The y-coordinate for the rotation pivot.</param>
|
|
<summary>Creates a matrix that represents a specific rotation in degrees, around a pivot point.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MakeScale(System.Single,System.Single)">
|
|
<param name="sx">The scaling in the x-direction.</param>
|
|
<param name="sy">The scaling in the y-direction.</param>
|
|
<summary>Creates a scaling matrix.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MakeScale(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="sx">The scaling in the x-direction.</param>
|
|
<param name="sy">The scaling in the y-direction.</param>
|
|
<param name="pivotX">The x-coordinate for the scaling pivot.</param>
|
|
<param name="pivotY">The y-coordinate for the scaling pivot.</param>
|
|
<summary>Creates a scaling matrix, around a pivot point.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MakeSkew(System.Single,System.Single)">
|
|
<param name="sx">The skew in the x-direction.</param>
|
|
<param name="sy">The skew in the y-direction.</param>
|
|
<summary>Creates a skewing matrix.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MakeTranslation(System.Single,System.Single)">
|
|
<param name="dx">The translation/offset in the x-direction.</param>
|
|
<param name="dy">The translation/offset in the y-direction.</param>
|
|
<summary>Creates a translation matrix.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapPoint(SkiaSharp.SKPoint)">
|
|
<param name="point">The point to map.</param>
|
|
<summary>Applies the matrix to a point.</summary>
|
|
<returns>Returns the mapped point.</returns>
|
|
<remarks>Mapping points uses all components of the matrix. Use <see cref="M:SkiaSharp.SKMatrix.MapVector(System.Single,System.Single)" /> to ignore the translation.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapPoint(System.Single,System.Single)">
|
|
<param name="x">The x-coordinate.</param>
|
|
<param name="y">The y-coordinate.</param>
|
|
<summary>Applies the matrix to a point.</summary>
|
|
<returns>Returns the mapped point.</returns>
|
|
<remarks>Mapping points uses all components of the matrix. Use <see cref="M:SkiaSharp.SKMatrix.MapVector(System.Single,System.Single)" /> to ignore the translation.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapPoints(SkiaSharp.SKPoint[])">
|
|
<param name="points">The array of points to be mapped.</param>
|
|
<summary>Applies the matrix to an array of points.</summary>
|
|
<returns>Returns the new array allocated with the mapped results.</returns>
|
|
<remarks>Mapping points uses all components of the matrix. Use <see cref="M:SkiaSharp.SKMatrix.MapVectors(SkiaSharp.SKPoint[])" /> to ignore the translation.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapPoints(SkiaSharp.SKPoint[],SkiaSharp.SKPoint[])">
|
|
<param name="result">The array where the mapped results will be stored (needs to have the same number of elements of the <paramref name="points" /> array).</param>
|
|
<param name="points">The array of points to be mapped.</param>
|
|
<summary>Applies the matrix to an array of points.</summary>
|
|
<remarks>Mapping points uses all components of the matrix. Use <see cref="M:SkiaSharp.SKMatrix.MapVectors(SkiaSharp.SKPoint[],SkiaSharp.SKPoint[])" /> to ignore the translation.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapRadius(System.Single)">
|
|
<param name="radius">The radius to map.</param>
|
|
<summary>Calculates the mean radius of a circle after it has been mapped by this matrix.</summary>
|
|
<returns>Returns the mean radius.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapRect(SkiaSharp.SKRect)">
|
|
<param name="source">The source rectangle to map.</param>
|
|
<summary>Applies the matrix to a rectangle.</summary>
|
|
<returns>Returns the mapped rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapRect(SkiaSharp.SKMatrix@,SkiaSharp.SKRect@,SkiaSharp.SKRect@)">
|
|
<param name="matrix">The transformation matrix.</param>
|
|
<param name="dest">The mapped rectangle.</param>
|
|
<param name="source">The source rectangle to map.</param>
|
|
<summary>Applies the matrix to a rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapVector(SkiaSharp.SKPoint)">
|
|
<param name="vector">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapVector(System.Single,System.Single)">
|
|
<param name="x">The x-component of the vector.</param>
|
|
<param name="y">The y-component of the vector.</param>
|
|
<summary>Applies the matrix to a vector, ignoring translation.</summary>
|
|
<returns>Returns the mapped point.</returns>
|
|
<remarks>Mapping vectors ignores the translation component in the matrix. Use <see cref="M:SkiaSharp.SKMatrix.MapXY(System.Single,System.Single)" /> to take the translation into consideration.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapVectors(SkiaSharp.SKPoint[])">
|
|
<param name="vectors">The array of vectors to map.</param>
|
|
<summary>Applies the matrix to the array of vectors, ignoring translation, and returns the mapped results.</summary>
|
|
<returns>Returns the new array allocated with the mapped results.</returns>
|
|
<remarks>Mapping vectors ignores the translation component in the matrix. Use <see cref="M:SkiaSharp.SKMatrix.MapPoints(SkiaSharp.SKPoint[])" /> to take the translation into consideration.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.MapVectors(SkiaSharp.SKPoint[],SkiaSharp.SKPoint[])">
|
|
<param name="result">The array where the mapped results will be stored (needs to have the same number of elements of the <paramref name="vectors" /> array).</param>
|
|
<param name="vectors">The array of vectors to map.</param>
|
|
<summary>Apply the to the array of vectors and return the mapped results..</summary>
|
|
<remarks>Mapping vectors ignores the translation component in the matrix. Use <see cref="M:SkiaSharp.SKMatrix.MapPoints(SkiaSharp.SKPoint[],SkiaSharp.SKPoint[])" /> to take the translation into consideration.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.op_Equality(SkiaSharp.SKMatrix,SkiaSharp.SKMatrix)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.op_Inequality(SkiaSharp.SKMatrix,SkiaSharp.SKMatrix)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.Persp0">
|
|
<summary>Gets or sets the x-perspective.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.Persp1">
|
|
<summary>Gets or sets the y-perspective.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.Persp2">
|
|
<summary>Gets or sets the z-perspective.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.PostConcat(SkiaSharp.SKMatrix)">
|
|
<param name="matrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.PostConcat(SkiaSharp.SKMatrix@,SkiaSharp.SKMatrix)">
|
|
<param name="target">The target matrix.</param>
|
|
<param name="matrix">The matrix to be post-concatenated.</param>
|
|
<summary>Post-concatenates the matrix to the target matrix.</summary>
|
|
<remarks>This represents: result = matrix * target</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.PostConcat(SkiaSharp.SKMatrix@,SkiaSharp.SKMatrix@)">
|
|
<param name="target">The target matrix.</param>
|
|
<param name="matrix">The matrix to be post-concatenated.</param>
|
|
<summary>Post-concatenates the matrix to the target matrix.</summary>
|
|
<remarks>This represents: result = matrix * target</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.PreConcat(SkiaSharp.SKMatrix)">
|
|
<param name="matrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.PreConcat(SkiaSharp.SKMatrix@,SkiaSharp.SKMatrix@)">
|
|
<param name="target">The target matrix.</param>
|
|
<param name="matrix">The matrix to be post-concatenated.</param>
|
|
<summary>Pre-concatenates the matrix to the target matrix.</summary>
|
|
<remarks>This represents: result = target * matrix</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.PreConcat(SkiaSharp.SKMatrix@,SkiaSharp.SKMatrix)">
|
|
<param name="target">The target matrix.</param>
|
|
<param name="matrix">The matrix to be post-concatenated.</param>
|
|
<summary>Pre-concatenates the matrix to the target matrix.</summary>
|
|
<remarks>This represents: result = target * matrix</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.Rotate(SkiaSharp.SKMatrix@,System.Single)">
|
|
<param name="matrix">The target matrix.</param>
|
|
<param name="radians">The angle for the rotation, in radians.</param>
|
|
<summary>Rotates the specified matrix by the specified radians.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.Rotate(SkiaSharp.SKMatrix@,System.Single,System.Single,System.Single)">
|
|
<param name="matrix">The target matrix.</param>
|
|
<param name="radians">The angle for the rotation, in radians.</param>
|
|
<param name="pivotx">The x-coordinate for the rotation pivot.</param>
|
|
<param name="pivoty">The y-coordinate for the rotation pivot.</param>
|
|
<summary>Rotates the specified matrix by the specified radians.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.RotateDegrees(SkiaSharp.SKMatrix@,System.Single)">
|
|
<param name="matrix">The target matrix.</param>
|
|
<param name="degrees">The angle for the rotation, in degrees.</param>
|
|
<summary>Rotates the specified matrix by the specified degrees.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.RotateDegrees(SkiaSharp.SKMatrix@,System.Single,System.Single,System.Single)">
|
|
<param name="matrix">The target matrix.</param>
|
|
<param name="degrees">The angle for the rotation, in degrees.</param>
|
|
<param name="pivotx">The x-coordinate for the rotation pivot.</param>
|
|
<param name="pivoty">The y-coordinate for the rotation pivot.</param>
|
|
<summary>Rotates the specified matrix by the specified degrees.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.ScaleX">
|
|
<summary>Gets or sets the scaling in the x-direction.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.ScaleY">
|
|
<summary>Gets or sets the scaling in the y-direction.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.SetScaleTranslate(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="sx">The scaling in the x-direction.</param>
|
|
<param name="sy">The scaling in the y-direction.</param>
|
|
<param name="tx">The translation in the x-direction.</param>
|
|
<param name="ty">The translation in the y-direction.</param>
|
|
<summary>Initializes the matrix to be scale + post-translate.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.SkewX">
|
|
<summary>Gets or sets the skew in the x-direction.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.SkewY">
|
|
<summary>Gets or sets the skew in the y-direction.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.TransX">
|
|
<summary>Get or sets the translation in the x-direction.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.TransY">
|
|
<summary>Get or sets the translation in the y-direction.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix.TryInvert(SkiaSharp.SKMatrix@)">
|
|
<param name="inverse">The destination value to store the inverted matrix if the matrix can be inverted.</param>
|
|
<summary>Attempts to invert the matrix, if possible the inverse matrix contains the result.</summary>
|
|
<returns>True if the matrix can be inverted, and the inverse parameter is initialized with the inverted matrix, false otherwise.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix.Values">
|
|
<summary>Gets or sets the matrix as a flat array: [ScaleX, SkewX, TransX, SkewY, ScaleY, TransY, Persp0, Persp1, Persp2].</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKMatrix44">
|
|
<summary>A 3D, 4x4 matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMatrix44">
|
|
<summary>Creates a new, uninitialized instance of <see cref="T:SkiaSharp.SKMatrix44" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMatrix44(SkiaSharp.SKMatrix)">
|
|
<param name="src">The <see cref="T:SkiaSharp.SKMatrix" /> instance.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKMatrix44" /> using the values from a <see cref="T:SkiaSharp.SKMatrix" /> instance.</summary>
|
|
<remarks>When converting from <see cref="T:SkiaSharp.SKMatrix" /> to <see cref="T:SkiaSharp.SKMatrix44" />, the third row and column remain as identity.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMatrix44(SkiaSharp.SKMatrix44)">
|
|
<param name="src">The matrix to copy.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKMatrix44" /> using the values from another instance.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMatrix44(SkiaSharp.SKMatrix44,SkiaSharp.SKMatrix44)">
|
|
<param name="a">The first matrix.</param>
|
|
<param name="b">The second matrix.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKMatrix44" /> using the concatenated values from two other instances.</summary>
|
|
<remarks>This is equivalent to creating an uninitialized matrix, and then passing the two matrices to <see cref="M:SkiaSharp.SKMatrix44.SetConcat(SkiaSharp.SKMatrix44,SkiaSharp.SKMatrix44)" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.CreateIdentity">
|
|
<summary>Creates a new identity matrix.</summary>
|
|
<returns>Returns the new identity matrix.</returns>
|
|
<remarks>This is equivalent to creating an uninitialized matrix, and invoking <see cref="M:SkiaSharp.SKMatrix44.SetIdentity" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.CreateRotation(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x">The x-axis to rotate around.</param>
|
|
<param name="y">The y-axis to rotate around.</param>
|
|
<param name="z">The z-axis to rotate around.</param>
|
|
<param name="radians">The amount, in radians, to rotate by.</param>
|
|
<summary>Creates a new rotation matrix.</summary>
|
|
<returns>Returns the new rotation matrix.</returns>
|
|
<remarks>This is equivalent to creating an uninitialized matrix and passing the values to <see cref="M:SkiaSharp.SKMatrix44.SetRotationAbout(System.Single,System.Single,System.Single,System.Single)" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.CreateRotationDegrees(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x">The x-axis to rotate around.</param>
|
|
<param name="y">The y-axis to rotate around.</param>
|
|
<param name="z">The z-axis to rotate around.</param>
|
|
<param name="degrees">The amount, in degrees, to rotate by.</param>
|
|
<summary>Creates a new rotation matrix.</summary>
|
|
<returns>Returns the new rotation matrix.</returns>
|
|
<remarks>This is equivalent to creating an uninitialized matrix and passing the values to <see cref="M:SkiaSharp.SKMatrix44.SetRotationAboutDegrees(System.Single,System.Single,System.Single,System.Single)" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.CreateScale(System.Single,System.Single,System.Single)">
|
|
<param name="x">The amount, along the x-axis, to scale.</param>
|
|
<param name="y">The amount, along the y-axis, to scale.</param>
|
|
<param name="z">The amount, along the z-axis, to scale.</param>
|
|
<summary>Creates a new scale matrix.</summary>
|
|
<returns>Returns the new scale matrix.</returns>
|
|
<remarks>This is equivalent to creating an uninitialized matrix and passing the values to <see cref="M:SkiaSharp.SKMatrix44.SetScale(System.Single,System.Single,System.Single)" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.CreateTranslate(System.Single,System.Single,System.Single)">
|
|
<param name="x">The amount, along the x-axis, to translate.</param>
|
|
<param name="y">The amount, along the y-axis, to translate.</param>
|
|
<param name="z">The amount, along the z-axis, to translate.</param>
|
|
<summary>Creates a new translation matrix.</summary>
|
|
<returns>Returns the new translation matrix.</returns>
|
|
<remarks>This is equivalent to creating an uninitialized matrix and passing the values to <see cref="M:SkiaSharp.SKMatrix44.SetTranslate(System.Single,System.Single,System.Single)" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.CreateTranslation(System.Single,System.Single,System.Single)">
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="z">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.Determinant">
|
|
<summary>Calculates the determinant of the matrix.</summary>
|
|
<returns>Returns the determinant.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKMatrix44" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKMatrix44" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.Equal(SkiaSharp.SKMatrix44,SkiaSharp.SKMatrix44)">
|
|
<param name="left">The first matrix.</param>
|
|
<param name="right">The second matrix.</param>
|
|
<summary>Determines if the two matrices are equal.</summary>
|
|
<returns>Returns <see langword="true" /> if the two matrices are equal, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.FromColumnMajor(System.Single[])">
|
|
<param name="src">The column-major array containing the values.</param>
|
|
<summary>Creates a new matrix using the values from the column-major array.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks>The number of items in the source array should be exactly 16 items.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.FromRowMajor(System.Single[])">
|
|
<param name="src">The row-major array containing the values.</param>
|
|
<summary>Creates a new matrix using the values from the row-major array.</summary>
|
|
<returns>Returns the new matrix.</returns>
|
|
<remarks>The number of items in the source array should be exactly 16 items.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.Invert">
|
|
<summary>Creates an inverted matrix from the current matrix.</summary>
|
|
<returns>Returns the inverted matrix if it is invertible, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.Invert(SkiaSharp.SKMatrix44)">
|
|
<param name="inverse">The matrix to receive the inverted matrix.</param>
|
|
<summary>Inverts the current matrix and stores the result in the provided matrix.</summary>
|
|
<returns>Returns <see langword="true" /> if the matrix is invertible, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix44.IsInvertible">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix44.Item(System.Int32,System.Int32)">
|
|
<param name="row">The row to retrieve the value from.</param>
|
|
<param name="column">The column to retrieve the value from.</param>
|
|
<summary>Gets or sets a value in the matrix.</summary>
|
|
<value>Returns the value found at the specified coordinates.</value>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.MapPoint(SkiaSharp.SKPoint)">
|
|
<param name="src">The point to map.</param>
|
|
<summary>Applies the matrix to a point.</summary>
|
|
<returns>Returns a new point with the matrix applied.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.MapPoints(SkiaSharp.SKPoint[])">
|
|
<param name="src">The points to map.</param>
|
|
<summary>Applies the matrix to an array of points.</summary>
|
|
<returns>Returns a new array of points with the matrix applied.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.MapScalars(System.Single[])">
|
|
<param name="srcVector4">The vector to map. The vector must have exactly 4 items.</param>
|
|
<summary>Applies the matrix to a vector.</summary>
|
|
<returns>Returns a new vector with the matrix applied.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.MapScalars(System.Single[],System.Single[])">
|
|
<param name="srcVector4">The vector to map. The vector must have exactly 4 items.</param>
|
|
<param name="dstVector4">The vector that will receive the mapped vector.</param>
|
|
<summary>Applies the matrix to a vector.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.MapScalars(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x">The x-value of the vector.</param>
|
|
<param name="y">The y-value of the vector.</param>
|
|
<param name="z">The z-value of the vector.</param>
|
|
<param name="w">The w-value of the vector.</param>
|
|
<summary>Applies the matrix to a vector.</summary>
|
|
<returns>Returns a new vector with the matrix applied.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.MapVector2(System.Single[])">
|
|
<param name="src2">The array of [x, y] pairs. The array must have an entry count of a multiple of 2.</param>
|
|
<summary>Applies the matrix to a series of [x, y] pairs, returning the [x', y', z', w'] result.</summary>
|
|
<returns>Returns the resulting [x', y', z', w'] sets.</returns>
|
|
<remarks>
|
|
<para>The source array must have an entry count of a multiple of 2 (2, 4, 6, 8, ...). The resulting array will have an entry count of a multiple of 4 (4, 8, 12, 16, ...).</para>
|
|
<para>The source array has an implied z-value of 0 and a w-value of 1, equivalent to [x, y, 0, 1].</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.MapVector2(System.Single[],System.Single[])">
|
|
<param name="src2">The array of [x, y] pairs. The array must have an entry count of a multiple of 2.</param>
|
|
<param name="dst4">Returns the resulting [x', y', z', w'] sets. The array must have an entry count of a multiple of 4, and the same number of vectors as the source has pairs.</param>
|
|
<summary>Applies the matrix to a series of [x, y] pairs, returning the [x', y', z', w'] result.</summary>
|
|
<remarks>The source array has an implied z-value of 0 and a w-value of 1, equivalent to [x, y, 0, 1].</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix44.Matrix">
|
|
<summary>Gets the <see cref="T:SkiaSharp.SKMatrix" /> equivalent of the current matrix.</summary>
|
|
<value />
|
|
<remarks>When converting from <see cref="T:SkiaSharp.SKMatrix44" /> to <see cref="T:SkiaSharp.SKMatrix" />, the third row and column is dropped.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.op_Implicit(SkiaSharp.SKMatrix)~SkiaSharp.SKMatrix44">
|
|
<param name="matrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.PostConcat(SkiaSharp.SKMatrix44)">
|
|
<param name="m">The matrix to concatenate.</param>
|
|
<summary>Post-concatenates the current matrix with the specified matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.PostScale(System.Single,System.Single,System.Single)">
|
|
<param name="sx">The amount, along the x-axis, to scale.</param>
|
|
<param name="sy">The amount, along the y-axis, to scale.</param>
|
|
<param name="sz">The amount, along the z-axis, to scale.</param>
|
|
<summary>Post-scales the current matrix with the specified scale.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.PostTranslate(System.Single,System.Single,System.Single)">
|
|
<param name="dx">The amount, along the x-axis, to translate.</param>
|
|
<param name="dy">The amount, along the y-axis, to translate.</param>
|
|
<param name="dz">The amount, along the z-axis, to translate.</param>
|
|
<summary>Post-translates the current matrix with the specified stranslationale.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.PreConcat(SkiaSharp.SKMatrix44)">
|
|
<param name="m">The matrix to concatenate.</param>
|
|
<summary>Pre-concatenates the matrix with the specified matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.PreScale(System.Single,System.Single,System.Single)">
|
|
<param name="sx">The amount, along the x-axis, to scale.</param>
|
|
<param name="sy">The amount, along the y-axis, to scale.</param>
|
|
<param name="sz">The amount, along the z-axis, to scale.</param>
|
|
<summary>Pre-scales the current matrix with the specified scale.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.Preserves2DAxisAlignment(System.Single)">
|
|
<param name="epsilon">The amount of error to allow for when determining axis-alignment.</param>
|
|
<summary>Determines if transforming an axis-aligned square in 2D by this matrix will produce another 2D, axis-aligned square.</summary>
|
|
<returns>Returns <see langword="true" /> if the matrix preserves 2D axis alignment, otherwise <see langword="false" />.</returns>
|
|
<remarks>If the result is <see langword="true" />, it typically means the matrix is a scale with perhaps a 90-degree rotation. A 3D rotation through 90 degrees into a perpendicular plane collapses a square to a line, but is still considered to be axis-aligned.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.PreTranslate(System.Single,System.Single,System.Single)">
|
|
<param name="dx">The amount, along the x-axis, to translate.</param>
|
|
<param name="dy">The amount, along the y-axis, to translate.</param>
|
|
<param name="dz">The amount, along the z-axis, to translate.</param>
|
|
<summary>Pre-translates the current matrix with the specified translation.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.Set3x3ColumnMajor(System.Single[])">
|
|
<param name="src">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.Set3x3RowMajor(System.Single[])">
|
|
<param name="src">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.SetColumnMajor(System.Single[])">
|
|
<param name="src">The array containing the new, column-major values.</param>
|
|
<summary>Resets the current matrix with the specified column-major values.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.SetConcat(SkiaSharp.SKMatrix44,SkiaSharp.SKMatrix44)">
|
|
<param name="a">The first matrix.</param>
|
|
<param name="b">The second matrix.</param>
|
|
<summary>Reset the current matrix with the values from the concatenation of the specified matrices.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.SetIdentity">
|
|
<summary>Resets the current matrix to identity.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.SetRotationAbout(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x">The x-axis to rotate around.</param>
|
|
<param name="y">The y-axis to rotate around.</param>
|
|
<param name="z">The z-axis to rotate around.</param>
|
|
<param name="radians">The amount, in radians, to rotate by.</param>
|
|
<summary>Resets the current matrix to a rotation matrix.</summary>
|
|
<remarks>If the specified vector is not unit-length, it will be automatically resized.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.SetRotationAboutDegrees(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x">The x-axis to rotate around.</param>
|
|
<param name="y">The y-axis to rotate around.</param>
|
|
<param name="z">The z-axis to rotate around.</param>
|
|
<param name="degrees">The amount, in degrees, to rotate by.</param>
|
|
<summary>Resets the current matrix to a rotation matrix.</summary>
|
|
<remarks>If the specified vector is not unit-length, it will be automatically resized.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.SetRotationAboutUnit(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x">The x-axis to rotate around.</param>
|
|
<param name="y">The y-axis to rotate around.</param>
|
|
<param name="z">The z-axis to rotate around.</param>
|
|
<param name="radians">The amount, in radians, to rotate by.</param>
|
|
<summary>Resets the current matrix to a rotation matrix, without checking to see if the specified vector is unit-length.</summary>
|
|
<remarks>This method assumes the specified vector is unit-length.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.SetRowMajor(System.Single[])">
|
|
<param name="src">The array containing the new, row-major values.</param>
|
|
<summary>Resets the current matrix with the specified row-major values.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.SetScale(System.Single,System.Single,System.Single)">
|
|
<param name="sx">The amount, along the x-axis, to scale.</param>
|
|
<param name="sy">The amount, along the y-axis, to scale.</param>
|
|
<param name="sz">The amount, along the z-axis, to scale.</param>
|
|
<summary>Resets the current matrix to a scale matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.SetTranslate(System.Single,System.Single,System.Single)">
|
|
<param name="dx">The amount, along the x-axis, to translate.</param>
|
|
<param name="dy">The amount, along the y-axis, to translate.</param>
|
|
<param name="dz">The amount, along the y-axis, to translate.</param>
|
|
<summary>Resets the current matrix to a translation matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.ToColumnMajor">
|
|
<summary>Converts the current matrix to a column-major array.</summary>
|
|
<returns>Returns the new column-major array.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.ToColumnMajor(System.Single[])">
|
|
<param name="dst">The array to receive the matrix values. The array must have an item count of exactly 16 items.</param>
|
|
<summary>Converts the current matrix to a column-major array.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.ToRowMajor">
|
|
<summary>Converts the current matrix to a row-major array.</summary>
|
|
<returns>Returns the new row-major array.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.ToRowMajor(System.Single[])">
|
|
<param name="dst">The array to receive the matrix values. The array must have an item count of exactly 16 items.</param>
|
|
<summary>Converts the current matrix to a row-major array.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMatrix44.Transpose">
|
|
<summary>Transposes the current matrix.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKMatrix44.Type">
|
|
<summary>Gets a bit field describing the transformations the matrix may perform.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKMatrix44TypeMask">
|
|
<summary>Various flags describing the transformations of a <see cref="T:SkiaSharp.SKMatrix44" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrix44TypeMask.Affine">
|
|
<summary>The matrix skews or rotates.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrix44TypeMask.Identity">
|
|
<summary>The matrix is an identity matrix.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrix44TypeMask.Perspective">
|
|
<summary>The matrix is in perspective.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrix44TypeMask.Scale">
|
|
<summary>The matrix has any scale other than 1.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrix44TypeMask.Translate">
|
|
<summary>The matrix has translation.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKMatrixConvolutionTileMode">
|
|
<summary>Matrix convolution tile modes for use with <see cref="M:SkiaSharp.SKImageFilter.CreateMatrixConvolution(SkiaSharp.SKSizeI,System.Single[],System.Single,System.Single,SkiaSharp.SKPointI,SkiaSharp.SKMatrixConvolutionTileMode,System.Boolean,SkiaSharp.SKImageFilter,SkiaSharp.SKImageFilter.CropRect)" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrixConvolutionTileMode.Clamp">
|
|
<summary>Clamp to the image's edge pixels.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrixConvolutionTileMode.ClampToBlack">
|
|
<summary>Fill with transparent black.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKMatrixConvolutionTileMode.Repeat">
|
|
<summary>Wrap around to the image's opposite edge.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKMemoryStream">
|
|
<summary>A memory-based stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMemoryStream">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKMemoryStream" /> with an empty buffer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMemoryStream(SkiaSharp.SKData)">
|
|
<param name="data">The data to initialize the stream with.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKMemoryStream" /> with the buffer being the provided data.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMemoryStream(System.Byte[])">
|
|
<param name="data">The data to initialize the stream with.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKMemoryStream" /> with a copy of the provided data.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKMemoryStream(System.UInt64)">
|
|
<param name="length">The size of the stream buffer.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKMemoryStream" /> with a buffer size of the specified size.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMemoryStream.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKMemoryStream" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKMemoryStream" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMemoryStream.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKMemoryStream.SetMemory(System.Byte[])">
|
|
<param name="data">The data to reset the stream to.</param>
|
|
<summary>Resets the stream with a copy of the provided data.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKNamedGamma">
|
|
<summary>Various standard gamma corrections.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKNamedGamma.Linear">
|
|
<summary>Standard linear gamma.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKNamedGamma.NonStandard">
|
|
<summary>Any non-standard gamma.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKNamedGamma.Srgb">
|
|
<summary>Standard sRGB gamma.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKNamedGamma.TwoDotTwoCurve">
|
|
<summary>Standard 2.2 gamma curve.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKNativeObject">
|
|
<summary>Represents a native object.</summary>
|
|
<remarks>This object just wraps a native handle with the managed dispose pattern. For a tracked object, use <see cref="T:SkiaSharp.SKObject" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNativeObject.Dispose">
|
|
<summary>Releases all resources used by this <see cref="T:SkiaSharp.SKNativeObject" />.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKNativeObject" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNativeObject.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKNativeObject" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKNativeObject" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNativeObject.DisposeInternal">
|
|
<summary>Triggers a dispose, ignoring the value of <see cref="P:SkiaSharp.SKNativeObject.IgnorePublicDispose" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNativeObject.DisposeManaged">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKNativeObject" /> types to destroy any managed objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNativeObject.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKNativeObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNativeObject.DisposeUnownedManaged">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNativeObject.Finalize">
|
|
<summary>Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKNativeObject.Handle">
|
|
<summary>Gets or sets the handle to the underlying native object.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKNativeObject.IgnorePublicDispose">
|
|
<summary>Gets or sets a value indicating whether the call the public <see cref="M:SkiaSharp.SKNativeObject.Dispose" /> should be no-op.</summary>
|
|
<value />
|
|
<remarks>This only affects the public disposal. Objects that own this one can still forcefull trigger a dispose using <see cref="M:SkiaSharp.SKNativeObject.DisposeInternal" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKNativeObject.IsDisposed">
|
|
<summary>Gets or sets a value indicating whether the object has already been disposed.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKNativeObject.OwnsHandle">
|
|
<summary>Gets or sets a value indicating whether this object owns it's handle and should destroy the native object when is is disposed.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKNoDrawCanvas">
|
|
<summary>A type of <see cref="T:SkiaSharp.SKCanvas" /> that provides a base type for canvases that do not need to rasterize.</summary>
|
|
<remarks>These canvases are not backed by any device/pixels and they use conservative clipping (clipping calls only use rectangles).</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKNoDrawCanvas(System.Int32,System.Int32)">
|
|
<param name="width">The width of the canvas.</param>
|
|
<param name="height">The height of the canvas.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKNoDrawCanvas" /> with the specified dimensions.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKNWayCanvas">
|
|
<summary>A type of <see cref="T:SkiaSharp.SKCanvas" /> that draws to multiple canvases at the same time.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKNWayCanvas(System.Int32,System.Int32)">
|
|
<param name="width">The width of the canvas.</param>
|
|
<param name="height">The height of the canvas.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKNWayCanvas" /> with the specified dimensions.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNWayCanvas.AddCanvas(SkiaSharp.SKCanvas)">
|
|
<param name="canvas">The canvas to add.</param>
|
|
<summary />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNWayCanvas.RemoveAll">
|
|
<summary>Remove all canvases.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKNWayCanvas.RemoveCanvas(SkiaSharp.SKCanvas)">
|
|
<param name="canvas">The canvas to remove.</param>
|
|
<summary />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKObject">
|
|
<summary>Represents a tracked native object.</summary>
|
|
<remarks>This object wraps a native handle and keeps track of it's lifetime for the garbage collector. For a simple object, use <see cref="T:SkiaSharp.SKNativeObject" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKObject.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKObject" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKObject" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKObject.DisposeManaged">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any managed objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKObject.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKObject.DisposeUnownedManaged">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKObject.Handle">
|
|
<summary>Gets or sets the handle to the underlying native object.</summary>
|
|
<value />
|
|
<remarks>Setting this value will register this object with the lifetime tracker.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKObject.OwnsHandle">
|
|
<summary>Gets a value indicating whether this object should destroy the underlying native object.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKOverdrawCanvas">
|
|
<summary>A canvas that captures all drawing commands, and rather than draw the actual content, it increments the alpha channel of each pixel every time it would have been touched by a draw call.</summary>
|
|
<remarks>This is useful for detecting overdraw.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKOverdrawCanvas(SkiaSharp.SKCanvas)">
|
|
<param name="canvas">The canvas to draw on.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKOverdrawCanvas" /> that wraps the specified <see cref="T:SkiaSharp.SKCanvas" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPaint">
|
|
<summary>Holds the style and color information about how to draw geometries, text and bitmaps.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><
|
|
|
|
### Effects Example
|
|
|
|
The following example draws using a gradient instead of a single color. To do,
|
|
this a `SKShader` is assigned to the paint. Anything drawn with that paint
|
|
will be drawn with the gradient specified in the call to
|
|
`SKShader.CreateLinearGradient`.
|
|
|
|
```csharp
|
|
var info = new SKImageInfo(256, 256);
|
|
using (var surface = SKSurface.Create(info)) {
|
|
SKCanvas canvas = surface.Canvas;
|
|
|
|
canvas.Clear(SKColors.White);
|
|
|
|
// create a gradient
|
|
var colors = new[] {
|
|
SKColors.Blue,
|
|
SKColors.Yellow
|
|
};
|
|
var shader = SKShader.CreateLinearGradient(
|
|
new SKPoint(0.0f, 0.0f),
|
|
new SKPoint(256.0f, 256.0f),
|
|
colors,
|
|
null,
|
|
SKShaderTileMode.Clamp);
|
|
|
|
// assign the gradient to the paint
|
|
var paint = new SKPaint {
|
|
Shader = shader
|
|
};
|
|
|
|
canvas.DrawPaint(paint);
|
|
}
|
|
```
|
|
|
|
The example above produces the following:
|
|
|
|

|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPaint">
|
|
<summary>Creates a new paint with the default settings.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPaint(SkiaSharp.SKFont)">
|
|
<param name="font">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.BlendMode">
|
|
<summary>Gets or sets the blend mode.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.Byte[],System.Single)">
|
|
<param name="text">The text to be measured.</param>
|
|
<param name="maxWidth">The maximum width. Only the subset of text whose accumulated widths are <= maxWidth are measured.</param>
|
|
<summary>Measure the text, stopping early if the measured width exceeds <paramref name="maxWidth" />.</summary>
|
|
<returns>Returns the number of bytes of text that were measured. </returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.ReadOnlySpan{System.Byte},System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="maxWidth">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.ReadOnlySpan{System.Char},System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="maxWidth">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.String,System.Single)">
|
|
<param name="text">The text to be measured.</param>
|
|
<param name="maxWidth">The maximum width. Only the subset of text whose accumulated widths are <= maxWidth are measured.</param>
|
|
<summary>Measure the text, stopping early if the measured width exceeds <paramref name="maxWidth" />.</summary>
|
|
<returns>Returns the number of characters of text that were measured. </returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.Byte[],System.Single,System.Single@)">
|
|
<param name="text">The text to be measured.</param>
|
|
<param name="maxWidth">The maximum width. Only the subset of text whose accumulated widths are <= <paramref name="maxWidth" /> are measured.</param>
|
|
<param name="measuredWidth">The actual width of the measured text.</param>
|
|
<summary>Measure the text, stopping early if the measured width exceeds <paramref name="maxWidth" />.</summary>
|
|
<returns>Returns the number of bytes of text that were measured. </returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.IntPtr,System.Int32,System.Single)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="maxWidth">The maximum width. Only the subset of text whose accumulated widths are <= <paramref name="maxWidth" /> are measured.</param>
|
|
<summary>Measure the text buffer, stopping early if the measured width exceeds <paramref name="maxWidth" />.</summary>
|
|
<returns>Returns the number of bytes of text that were measured. </returns>
|
|
<remarks>The <paramref name="buffer" /> parameter is a pointer to a region in memory that contains text encoded in the <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format. This only consumes up to <paramref name="length" /> bytes from the buffer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.IntPtr,System.IntPtr,System.Single)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="maxWidth">The maximum width. Only the subset of text whose accumulated widths are <= <paramref name="maxWidth" /> are measured.</param>
|
|
<summary>Measure the text buffer, stopping early if the measured width exceeds <paramref name="maxWidth" />.</summary>
|
|
<returns>Returns the number of bytes of text that were measured. </returns>
|
|
<remarks>The <paramref name="buffer" /> parameter is a pointer to a region in memory that contains text encoded in the <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format. This only consumes up to <paramref name="length" /> bytes from the buffer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.ReadOnlySpan{System.Byte},System.Single,System.Single@)">
|
|
<param name="text">To be added.</param>
|
|
<param name="maxWidth">To be added.</param>
|
|
<param name="measuredWidth">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.ReadOnlySpan{System.Char},System.Single,System.Single@)">
|
|
<param name="text">To be added.</param>
|
|
<param name="maxWidth">To be added.</param>
|
|
<param name="measuredWidth">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.String,System.Single,System.Single@)">
|
|
<param name="text">The text to be measured.</param>
|
|
<param name="maxWidth">The maximum width. Only the subset of text whose accumulated widths are <= <paramref name="maxWidth" /> are measured.</param>
|
|
<param name="measuredWidth">The actual width of the measured text.</param>
|
|
<summary>Measure the text, stopping early if the measured width exceeds <paramref name="maxWidth" />.</summary>
|
|
<returns>Returns the number of characters of text that were measured. </returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.IntPtr,System.Int32,System.Single,System.Single@)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="maxWidth">The maximum width. Only the subset of text whose accumulated widths are <= <paramref name="maxWidth" /> are measured.</param>
|
|
<param name="measuredWidth">The actual width of the measured text.</param>
|
|
<summary>Measure the text buffer, stopping early if the measured width exceeds <paramref name="maxWidth" />.</summary>
|
|
<returns>Returns the number of bytes of text that were measured. </returns>
|
|
<remarks>The <paramref name="buffer" /> parameter is a pointer to a region in memory that contains text encoded in the <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format. This only consumes up to <paramref name="length" /> bytes from the buffer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.IntPtr,System.IntPtr,System.Single,System.Single@)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="maxWidth">The maximum width. Only the subset of text whose accumulated widths are <= <paramref name="maxWidth" /> are measured.</param>
|
|
<param name="measuredWidth">The actual width of the measured text.</param>
|
|
<summary>Measure the text buffer, stopping early if the measured width exceeds <paramref name="maxWidth" />.</summary>
|
|
<returns>Returns the number of bytes of text that were measured. </returns>
|
|
<remarks>The <paramref name="buffer" /> parameter is a pointer to a region in memory that contains text encoded in the <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format. This only consumes up to <paramref name="length" /> bytes from the buffer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.BreakText(System.String,System.Single,System.Single@,System.String@)">
|
|
<param name="text">The text to be measured.</param>
|
|
<param name="maxWidth">The maximum width. Only the subset of text whose accumulated widths are <= <paramref name="maxWidth" /> are measured.</param>
|
|
<param name="measuredWidth">The actual width of the measured text.</param>
|
|
<param name="measuredText">The text that was measured.</param>
|
|
<summary>Measure the text, stopping early if the measured width exceeds <paramref name="maxWidth" />.</summary>
|
|
<returns>Returns the number of characters of text that were measured. </returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.Clone">
|
|
<summary>Creates a copy of the current paint.</summary>
|
|
<returns>Returns the copy.</returns>
|
|
<remarks>The copy is a shallow copy, all references will still point to the same objects.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.Color">
|
|
<summary>Gets or sets the paint's foreground color.</summary>
|
|
<value />
|
|
<remarks>The color is a 32-bit value containing ARGB. This 32-bit value is not premultiplied, meaning that its alpha can be any value, regardless of the values of R, G and B.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.ColorF">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.ColorFilter">
|
|
<summary>Gets or sets the paint's color filter.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.ContainsGlyphs(System.Byte[])">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<summary>Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index.</summary>
|
|
<returns>Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface.</returns>
|
|
<remarks>This method does not check to see if the text contains invalid glyph indices.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.ContainsGlyphs(System.ReadOnlySpan{System.Byte})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.ContainsGlyphs(System.ReadOnlySpan{System.Char})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.ContainsGlyphs(System.String)">
|
|
<param name="text">The text.</param>
|
|
<summary>Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index.</summary>
|
|
<returns>Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface.</returns>
|
|
<remarks>This method does not check to see if the text contains invalid glyph indices.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.ContainsGlyphs(System.IntPtr,System.Int32)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<summary>Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index.</summary>
|
|
<returns>Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface.</returns>
|
|
<remarks>This method does not check to see if the text contains invalid glyph indices.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.ContainsGlyphs(System.IntPtr,System.IntPtr)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<summary>Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index.</summary>
|
|
<returns>Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface.</returns>
|
|
<remarks>This method does not check to see if the text contains invalid glyph indices.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.CountGlyphs(System.Byte[])">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<summary>Returns the number of glyphs in text.</summary>
|
|
<returns>Returns the number of glyphs in text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.CountGlyphs(System.ReadOnlySpan{System.Byte})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.CountGlyphs(System.ReadOnlySpan{System.Char})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.CountGlyphs(System.String)">
|
|
<param name="text">The text.</param>
|
|
<summary>Returns the number of glyphs in text.</summary>
|
|
<returns>Returns the number of glyphs in text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.CountGlyphs(System.IntPtr,System.Int32)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<summary>Returns the number of glyphs in text.</summary>
|
|
<returns>Returns the number of glyphs in text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.CountGlyphs(System.IntPtr,System.IntPtr)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<summary>Returns the number of glyphs in text.</summary>
|
|
<returns>Returns the number of glyphs in text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.DeviceKerningEnabled">
|
|
<summary>Gets or sets a value indicating whether device kerning is enabled.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPaint" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPaint" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.FakeBoldText">
|
|
<summary>Gets or sets a value indicating whether fake bold text is enabled.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.FilterQuality">
|
|
<summary>Gets or sets the filter quality of the current paint.</summary>
|
|
<value />
|
|
<remarks>This affects the quality (and performance) of drawing scaled images.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.FontMetrics">
|
|
<summary>Gets the font metrics for the current typeface.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.FontSpacing">
|
|
<summary>Gets the recommend line spacing.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath)">
|
|
<param name="src">The source path.</param>
|
|
<summary>Creates a new path from the result of applying any and all effects to a source path.</summary>
|
|
<returns>Returns the resulting fill path, or null if the source path should be drawn with a hairline.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPath)">
|
|
<param name="src">The input path.</param>
|
|
<param name="dst">The output path.</param>
|
|
<summary>Applies any and all effects to a source path, returning the result in the destination.</summary>
|
|
<returns>Returns true if the path should be filled, or false if it should be drawn with a hairline.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKRect)">
|
|
<param name="src">The source path.</param>
|
|
<param name="cullRect">The limit to be passed to the path effect.</param>
|
|
<summary>Creates a new path from the result of applying any and all effects to a source path.</summary>
|
|
<returns>Returns the resulting fill path, or null if the source path should be drawn with a hairline.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,System.Single)">
|
|
<param name="src">The source path.</param>
|
|
<param name="resScale">If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size.</param>
|
|
<summary>Creates a new path from the result of applying any and all effects to a source path.</summary>
|
|
<returns>Returns the resulting fill path, or null if the source path should be drawn with a hairline.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPath,SkiaSharp.SKRect)">
|
|
<param name="src">The source path.</param>
|
|
<param name="dst">The output path.</param>
|
|
<param name="cullRect">The limit to be passed to the path effect.</param>
|
|
<summary>Applies any and all effects to a source path, returning the result in the destination.</summary>
|
|
<returns>Returns true if the path should be filled, or false if it should be drawn with a hairline.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPath,System.Single)">
|
|
<param name="src">The input path.</param>
|
|
<param name="dst">The output path.</param>
|
|
<param name="resScale">If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size.</param>
|
|
<summary>Applies any and all effects to a source path, returning the result in the destination.</summary>
|
|
<returns>Returns true if the path should be filled, or false if it should be drawn with a hairline.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKRect,System.Single)">
|
|
<param name="src">The source path.</param>
|
|
<param name="cullRect">The limit to be passed to the path effect.</param>
|
|
<param name="resScale">If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size.</param>
|
|
<summary>Creates a new path from the result of applying any and all effects to a source path.</summary>
|
|
<returns>Returns the resulting fill path, or null if the source path should be drawn with a hairline.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPath,SkiaSharp.SKRect,System.Single)">
|
|
<param name="src">The input path.</param>
|
|
<param name="dst">The output path.</param>
|
|
<param name="cullRect">The destination path may be culled to this rectangle.</param>
|
|
<param name="resScale">If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size.</param>
|
|
<summary>Applies any and all effects to a source path, returning the result in the destination.</summary>
|
|
<returns>Returns true if the path should be filled, or false if it should be drawn with a hairline.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFontMetrics(SkiaSharp.SKFontMetrics@)">
|
|
<param name="metrics">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetFontMetrics(SkiaSharp.SKFontMetrics@,System.Single)">
|
|
<param name="metrics">The font metrics for the current typeface.</param>
|
|
<param name="scale">If not 0, return width as if the canvas were scaled by this value.</param>
|
|
<summary>Returns the font metrics and line spacing for the current typeface.</summary>
|
|
<returns>Returns the recommended spacing between lines.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphOffsets(System.ReadOnlySpan{System.Byte},System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphOffsets(System.ReadOnlySpan{System.Char},System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphOffsets(System.String,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphOffsets(System.IntPtr,System.Int32,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphPositions(System.ReadOnlySpan{System.Byte},SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphPositions(System.ReadOnlySpan{System.Char},SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphPositions(System.String,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphPositions(System.IntPtr,System.Int32,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphs(System.Byte[])">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<summary>Converts text into glyph indices.</summary>
|
|
<returns>Returns the glyph indices.</returns>
|
|
<remarks>This method does not check the text for valid character codes or valid glyph indices.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphs(System.ReadOnlySpan{System.Byte})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphs(System.ReadOnlySpan{System.Char})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphs(System.String)">
|
|
<param name="text">The text.</param>
|
|
<summary>Converts text into glyph indices.</summary>
|
|
<returns>Returns the glyph indices.</returns>
|
|
<remarks>This method does not check the text for valid character codes or valid glyph indices.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphs(System.IntPtr,System.Int32)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<summary>Converts text into glyph indices.</summary>
|
|
<returns>Returns the glyph indices.</returns>
|
|
<remarks>This method does not check the text for valid character codes or valid glyph indices.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphs(System.IntPtr,System.IntPtr)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<summary>Converts text into glyph indices.</summary>
|
|
<returns>Returns the glyph indices.</returns>
|
|
<remarks>This method does not check the text for valid character codes or valid glyph indices.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.Byte[])">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<summary>Retrieves the advance for each glyph in the text.</summary>
|
|
<returns>Returns the text advances for each glyph.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
|
|
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
|
|
method returns the vertical advance.
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.ReadOnlySpan{System.Byte})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.ReadOnlySpan{System.Char})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.String)">
|
|
<param name="text">The text.</param>
|
|
<summary>Retrieves the advance for each glyph in the text.</summary>
|
|
<returns>Returns the text advances for each glyph.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
|
|
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
|
|
method returns the vertical advance.
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.Byte[],SkiaSharp.SKRect[]@)">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="bounds">The bounds for each glyph relative to (0, 0).</param>
|
|
<summary>Retrieves the advance and bounds for each glyph in the text.</summary>
|
|
<returns>Returns the text advances for each glyph.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
|
|
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
|
|
method returns the vertical advance.
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths and bounds.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.IntPtr,System.Int32)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<summary>Retrieves the advance for each glyph in the text.</summary>
|
|
<returns>Returns the text advances for each glyph.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
|
|
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
|
|
method returns the vertical advance.
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.IntPtr,System.IntPtr)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<summary>Retrieves the advance for each glyph in the text.</summary>
|
|
<returns>Returns the text advances for each glyph.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
|
|
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
|
|
method returns the vertical advance.
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.ReadOnlySpan{System.Byte},SkiaSharp.SKRect[]@)">
|
|
<param name="text">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.ReadOnlySpan{System.Char},SkiaSharp.SKRect[]@)">
|
|
<param name="text">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.String,SkiaSharp.SKRect[]@)">
|
|
<param name="text">The text.</param>
|
|
<param name="bounds">The bounds for each glyph relative to (0, 0).</param>
|
|
<summary>Retrieves the advance and bounds for each glyph in the text.</summary>
|
|
<returns>Returns the text advances for each glyph.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
|
|
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
|
|
method returns the vertical advance.
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths and bounds.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.IntPtr,System.Int32,SkiaSharp.SKRect[]@)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<param name="bounds">The bounds for each glyph relative to (0, 0).</param>
|
|
<summary>Retrieves the advance and bounds for each glyph in the text.</summary>
|
|
<returns>Returns the text advances for each glyph.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
|
|
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
|
|
method returns the vertical advance.
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths and bounds.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetGlyphWidths(System.IntPtr,System.IntPtr,SkiaSharp.SKRect[]@)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<param name="bounds">The bounds for each glyph relative to (0, 0).</param>
|
|
<summary>Retrieves the advance and bounds for each glyph in the text.</summary>
|
|
<returns>Returns the text advances for each glyph.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
|
|
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
|
|
method returns the vertical advance.
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths and bounds.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetHorizontalTextIntercepts(System.Byte[],System.Single[],System.Single,System.Single,System.Single)">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="xpositions">The positions of each glyph in the horizontal direction.</param>
|
|
<param name="y">The positions of all the glyphs along the y-coordinate.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetHorizontalTextIntercepts(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Single},System.Single,System.Single,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="xpositions">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="upperBounds">To be added.</param>
|
|
<param name="lowerBounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetHorizontalTextIntercepts(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Single},System.Single,System.Single,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="xpositions">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="upperBounds">To be added.</param>
|
|
<param name="lowerBounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetHorizontalTextIntercepts(System.String,System.Single[],System.Single,System.Single,System.Single)">
|
|
<param name="text">The text.</param>
|
|
<param name="xpositions">The positions of each glyph in the horizontal direction.</param>
|
|
<param name="y">The positions of all the glyphs along the y-coordinate.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetHorizontalTextIntercepts(System.IntPtr,System.Int32,System.Single[],System.Single,System.Single,System.Single)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<param name="xpositions">The positions of each glyph in the horizontal direction.</param>
|
|
<param name="y">The positions of all the glyphs along the y-coordinate.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetHorizontalTextIntercepts(System.IntPtr,System.IntPtr,System.Single[],System.Single,System.Single,System.Single)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<param name="xpositions">The positions of each glyph in the horizontal direction.</param>
|
|
<param name="y">The positions of all the glyphs along the y-coordinate.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetPositionedTextIntercepts(System.Byte[],SkiaSharp.SKPoint[],System.Single,System.Single)">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetPositionedTextIntercepts(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{SkiaSharp.SKPoint},System.Single,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<param name="upperBounds">To be added.</param>
|
|
<param name="lowerBounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetPositionedTextIntercepts(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{SkiaSharp.SKPoint},System.Single,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<param name="upperBounds">To be added.</param>
|
|
<param name="lowerBounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetPositionedTextIntercepts(System.String,SkiaSharp.SKPoint[],System.Single,System.Single)">
|
|
<param name="text">The text.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetPositionedTextIntercepts(System.IntPtr,System.Int32,SkiaSharp.SKPoint[],System.Single,System.Single)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetPositionedTextIntercepts(System.IntPtr,System.IntPtr,SkiaSharp.SKPoint[],System.Single,System.Single)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextIntercepts(SkiaSharp.SKTextBlob,System.Single,System.Single)">
|
|
<param name="text">The text blob.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextIntercepts(System.Byte[],System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="x">The x-coordinate of the origin to the text.</param>
|
|
<param name="y">The y-coordinate of the origin to the text.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextIntercepts(System.ReadOnlySpan{System.Byte},System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="upperBounds">To be added.</param>
|
|
<param name="lowerBounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextIntercepts(System.ReadOnlySpan{System.Char},System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="upperBounds">To be added.</param>
|
|
<param name="lowerBounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextIntercepts(System.String,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="text">The text.</param>
|
|
<param name="x">The x-coordinate of the origin to the text.</param>
|
|
<param name="y">The y-coordinate of the origin to the text.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextIntercepts(System.IntPtr,System.Int32,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<param name="x">The x-coordinate of the origin to the text.</param>
|
|
<param name="y">The y-coordinate of the origin to the text.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextIntercepts(System.IntPtr,System.IntPtr,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The length of the text buffer.</param>
|
|
<param name="x">The x-coordinate of the origin to the text.</param>
|
|
<param name="y">The y-coordinate of the origin to the text.</param>
|
|
<param name="upperBounds">The upper line parallel to the advance.</param>
|
|
<param name="lowerBounds">The lower line parallel to the advance.</param>
|
|
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
|
|
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
|
|
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
|
|
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
|
|
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.Byte[],SkiaSharp.SKPoint[])">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="points">The position to use for each glyph in the text.</param>
|
|
<summary>Returns the path (outline) for the specified text.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPath" /> containing the outline of the text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="text">To be added.</param>
|
|
<param name="points">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="text">To be added.</param>
|
|
<param name="points">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.String,SkiaSharp.SKPoint[])">
|
|
<param name="text">The text to generate an outline for.</param>
|
|
<param name="points">The position to use for each glyph in the text.</param>
|
|
<summary>Returns the path (outline) for the specified text.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPath" /> containing the outline of the text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.Byte[],System.Single,System.Single)">
|
|
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="x">The x-coordinate of the first glyph in the text.</param>
|
|
<param name="y">The y-coordinate of the first glyph in the text.</param>
|
|
<summary>Returns the path (outline) for the specified text.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPath" /> containing the outline of the text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.IntPtr,System.Int32,SkiaSharp.SKPoint[])">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="points">The position to use for each glyph in the text.</param>
|
|
<summary>Returns the path (outline) for the specified text.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPath" /> containing the outline of the text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.IntPtr,System.Int32,System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="buffer">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="points">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.IntPtr,System.IntPtr,SkiaSharp.SKPoint[])">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="points">The position to use for each glyph in the text.</param>
|
|
<summary>Returns the path (outline) for the specified text.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPath" /> containing the outline of the text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.ReadOnlySpan{System.Byte},System.Single,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.ReadOnlySpan{System.Char},System.Single,System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.String,System.Single,System.Single)">
|
|
<param name="text">The text to generate an outline for.</param>
|
|
<param name="x">The x-coordinate of the first glyph in the text.</param>
|
|
<param name="y">The y-coordinate of the first glyph in the text.</param>
|
|
<summary>Returns the path (outline) for the specified text.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPath" /> containing the outline of the text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.IntPtr,System.Int32,System.Single,System.Single)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="x">The x-coordinate of the first glyph in the text.</param>
|
|
<param name="y">The y-coordinate of the first glyph in the text.</param>
|
|
<summary>Returns the path (outline) for the specified text.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPath" /> containing the outline of the text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.GetTextPath(System.IntPtr,System.IntPtr,System.Single,System.Single)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="x">The x-coordinate of the first glyph in the text.</param>
|
|
<param name="y">The y-coordinate of the first glyph in the text.</param>
|
|
<summary>Returns the path (outline) for the specified text.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPath" /> containing the outline of the text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.HintingLevel">
|
|
<summary>Gets or sets the level of hinting to be performed.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.ImageFilter">
|
|
<summary>Gets or sets the image filter.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.IsAntialias">
|
|
<summary>Gets or sets a value indicating whether anti-aliasing is enabled.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.IsAutohinted">
|
|
<summary>Gets or sets a value indicating whether auto-hinting is enabled.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.IsDither">
|
|
<summary>Gets or sets a value indicating whether dithering is enabled.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.IsEmbeddedBitmapText">
|
|
<summary>Gets or sets a value indicating whether text is an embedded bitmap.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.IsLinearText">
|
|
<summary>Gets or sets a value indicating whether text is linear.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.IsStroke">
|
|
<summary>Gets or sets a value indicating whether to paint a stroke or the fill.</summary>
|
|
<value />
|
|
<remarks>This is a shortcut way to set <see cref="P:SkiaSharp.SKPaint.Style" /> to either <see cref="F:SkiaSharp.SKPaintStyle.Stroke" /> or <see cref="F:SkiaSharp.SKPaintStyle.Fill" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.IsVerticalText">
|
|
<summary>Gets or sets a value indicating whether the text is vertical or horizontal is enabled.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If this property is set true, then advances are treated as Y values rather
|
|
than X values, and
|
|
<xref:SkiaSharp.SKCanvas.DrawText%2A> will place
|
|
its glyphs vertically rather than horizontally.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.LcdRenderText">
|
|
<summary>Gets or sets a value indicating whether LCD text rendering is enabled.</summary>
|
|
<value />
|
|
<remarks>
|
|
<see cref="P:SkiaSharp.SKPaint.IsAntialias" /> must also be enabled for LCD rendering to be enabled.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.MaskFilter">
|
|
<summary>Gets or sets the mask filter to use when painting.</summary>
|
|
<value />
|
|
<remarks>Mask filters control the transformations on the alpha channel before primitives are drawn. Examples are blur or emboss.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.Byte[])">
|
|
<param name="text">The text to be measured.</param>
|
|
<summary>Measures the specified text.</summary>
|
|
<returns>Returns the width of the text.</returns>
|
|
<remarks>This will return the vertical measure if this is vertical text, in which case the returned value should be treated has a height instead of a width.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.ReadOnlySpan{System.Byte})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.ReadOnlySpan{System.Char})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.String)">
|
|
<param name="text">The text to be measured.</param>
|
|
<summary>Measures the specified text.</summary>
|
|
<returns>Returns the width of the text.</returns>
|
|
<remarks>This will return the vertical measure if this is vertical text, in which case the returned value should be treated has a height instead of a width.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.Byte[],SkiaSharp.SKRect@)">
|
|
<param name="text">The text to be measured.</param>
|
|
<param name="bounds">The bounds of the text relative to (0, 0)</param>
|
|
<summary>Measures the specified text.</summary>
|
|
<returns>Returns the width of the text.</returns>
|
|
<remarks>This will return the vertical measure if this is vertical text, in which case the returned value should be treated has a height instead of a width.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.IntPtr,System.Int32)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<summary>Measures the specified UTF-8 encoded text.</summary>
|
|
<returns>Returns the width of the text.</returns>
|
|
<remarks>The <paramref name="buffer" /> parameter is a pointer to a region in memory that contains text encoded in the <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format. This only consumes up to <paramref name="length" /> bytes from the buffer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.IntPtr,System.IntPtr)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<summary>Measures the specified UTF-8 encoded text.</summary>
|
|
<returns>Returns the width of the text.</returns>
|
|
<remarks>The <paramref name="buffer" /> parameter is a pointer to a region in memory that contains text encoded in the <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format. This only consumes up to <paramref name="length" /> bytes from the buffer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.ReadOnlySpan{System.Byte},SkiaSharp.SKRect@)">
|
|
<param name="text">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.ReadOnlySpan{System.Char},SkiaSharp.SKRect@)">
|
|
<param name="text">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.String,SkiaSharp.SKRect@)">
|
|
<param name="text">The text to be measured.</param>
|
|
<param name="bounds">The bounds of the text relative to (0, 0)</param>
|
|
<summary>Measures the specified text.</summary>
|
|
<returns>Returns the width of the text.</returns>
|
|
<remarks>This will return the vertical measure if this is vertical text, in which case the returned value should be treated has a height instead of a width.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.IntPtr,System.Int32,SkiaSharp.SKRect@)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="bounds">The bounds of the text relative to (0, 0)</param>
|
|
<summary>Measures the specified UTF-8 encoded text.</summary>
|
|
<returns>Returns the width of the text.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This will return the vertical measure if this is vertical text, in which case
|
|
the returned value should be treated has a height instead of a width.
|
|
|
|
The `buffer` parameter is a pointer to a region in memory that contains text
|
|
encoded in the <xref:SkiaSharp.SKPaint.TextEncoding> format. This only
|
|
consumes up to `length` bytes from the buffer.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.MeasureText(System.IntPtr,System.IntPtr,SkiaSharp.SKRect@)">
|
|
<param name="buffer">The pointer to a region holding text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
|
|
<param name="length">The number of bytes to read from the <paramref name="buffer." /></param>
|
|
<param name="bounds">The bounds of the text relative to (0, 0)</param>
|
|
<summary>Measures the specified UTF-8 encoded text.</summary>
|
|
<returns>Returns the width of the text.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This will return the vertical measure if this is vertical text, in which case
|
|
the returned value should be treated has a height instead of a width.
|
|
|
|
The `buffer` parameter is a pointer to a region in memory that contains text
|
|
encoded in the <xref:SkiaSharp.SKPaint.TextEncoding> format. This only
|
|
consumes up to `length` bytes from the buffer.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.PathEffect">
|
|
<summary>Gets or sets the path effect to use when painting.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.Reset">
|
|
<summary>Resets all the paint properties to their defaults.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.SetColor(SkiaSharp.SKColorF,SkiaSharp.SKColorSpace)">
|
|
<param name="color">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.Shader">
|
|
<summary>Gets or sets the shader to use when painting.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.StrokeCap">
|
|
<summary>Gets or sets a value indicating how the start and end of stroked lines and paths are treated.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.StrokeJoin">
|
|
<summary>Gets or sets the path's join type.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.StrokeMiter">
|
|
<summary>Gets or sets the paint's miter limit.</summary>
|
|
<value />
|
|
<remarks>This is used whenever the <see cref="P:SkiaSharp.SKPaint.Style" /> is <see cref="F:SkiaSharp.SKPaintStyle.Stroke" /> or <see cref="F:SkiaSharp.SKPaintStyle.StrokeAndFill" /> to control the behavior of miter joins when the joins' angle is sharp.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.StrokeWidth">
|
|
<summary>Gets or sets the paint's stroke width.</summary>
|
|
<value />
|
|
<remarks>This is used whenever the <see cref="P:SkiaSharp.SKPaint.Style" /> is <see cref="F:SkiaSharp.SKPaintStyle.Stroke" /> or <see cref="F:SkiaSharp.SKPaintStyle.StrokeAndFill" />. The value of zero is the special hairline mode. Hairlines always draw with a width of 1 pixel, regardless of the transformation matrix.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.Style">
|
|
<summary>Gets or sets the painting style.</summary>
|
|
<value />
|
|
<remarks>Can also be set using <see cref="P:SkiaSharp.SKPaint.IsStroke" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.SubpixelText">
|
|
<summary>Gets or sets a value indicating whether to use subpixel text positioning.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.TextAlign">
|
|
<summary>Gets or sets the path's align value.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.TextEncoding">
|
|
<summary>Gets or sets the encoding used when drawing or measuring text.</summary>
|
|
<value />
|
|
<remarks>This defaults to UTF-8 encoding.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.TextScaleX">
|
|
<summary>Gets or sets paint's horizontal scale factor for text.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.TextSize">
|
|
<summary>Gets or sets the text height in pixels.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.TextSkewX">
|
|
<summary>Gets or sets paint's horizontal skew factor for text.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPaint.ToFont">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPaint.Typeface">
|
|
<summary>Gets or sets the typeface used when painting text. May be <see langword="null" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPaintHinting">
|
|
<summary>Levels of hinting that can be performed.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPaintHinting.Full">
|
|
<summary>The same as <see cref="F:SkiaSharp.SKPaintHinting.Normal" />, unless we are rendering subpixel glyphs.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPaintHinting.NoHinting">
|
|
<summary>Don't perform hinting.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPaintHinting.Normal">
|
|
<summary>Use the default hinting level.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPaintHinting.Slight">
|
|
<summary>Use a lighter hinting level.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPaintStyle">
|
|
<summary>Indications on how to draw geometry.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Styles apply to rectangle, oval, path, and text. Bitmaps are always drawn in
|
|
<xref:SkiaSharp.SKPaintStyle.Fill>, and lines are always drawn in
|
|
<xref:SkiaSharp.SKPaintStyle.Stroke>.
|
|
|
|
<xref:SkiaSharp.SKPaintStyle.StrokeAndFill> implicitly draws the result with
|
|
<xref:SkiaSharp.SKPathFillType.Winding> so if the original path is even-odd,
|
|
the results may not appear the same as if it was drawn twice, filled and then
|
|
stroked.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPaintStyle.Fill">
|
|
<summary>Fill the geometry.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPaintStyle.Stroke">
|
|
<summary>Stroke the geometry.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPaintStyle.StrokeAndFill">
|
|
<summary>Fill and stroke the geometry.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPath">
|
|
<summary>A compound geometric path.</summary>
|
|
<remarks>A path encapsulates compound (multiple contour) geometric paths consisting of straight line segments, quadratic curves, and cubic curves.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPath">
|
|
<summary>Creates an empty path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPath(SkiaSharp.SKPath)">
|
|
<param name="path">The path to clone.</param>
|
|
<summary>Creates a path by making a copy of an existing path.</summary>
|
|
<remarks>This constructor can throw InvalidOperationException if there is a problem copying the source path.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddArc(SkiaSharp.SKRect,System.Single,System.Single)">
|
|
<param name="oval">The bounds of oval used to define the size of the arc.</param>
|
|
<param name="startAngle">Starting angle (in degrees) where the arc begins.</param>
|
|
<param name="sweepAngle">Sweep angle (in degrees) measured clockwise.</param>
|
|
<summary>Adds the specified arc to the path as a new contour.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddCircle(System.Single,System.Single,System.Single,SkiaSharp.SKPathDirection)">
|
|
<param name="x">The x-coordinate of the center of the circle.</param>
|
|
<param name="y">The y-coordinate of the center of the circle.</param>
|
|
<param name="radius">The radius of the circle.</param>
|
|
<param name="dir">The direction to wind the circle's contour.</param>
|
|
<summary>Adds a closed circle contour to the path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddOval(SkiaSharp.SKRect,SkiaSharp.SKPathDirection)">
|
|
<param name="rect">The bounding oval to add as a closed contour to the path.</param>
|
|
<param name="direction">The direction to wind the oval's contour.</param>
|
|
<summary>Adds a closed oval contour to the path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddPath(SkiaSharp.SKPath,SkiaSharp.SKPathAddMode)">
|
|
<param name="other">The path containing the elements to be added to the current path.</param>
|
|
<param name="mode">Determines how the <paramref name="other" /> path contours are added to the path. On <see cref="F:SkiaSharp.SKPathAddMode.Append" /> mode, contours are added as new contours. On <see cref="F:SkiaSharp.SKPathAddMode.Extend" /> mode, the last contour of the path is extended with the first contour of the <paramref name="other" /> path.</param>
|
|
<summary>Extends the current path with the path elements from another path, using the specified extension mode.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddPath(SkiaSharp.SKPath,SkiaSharp.SKMatrix@,SkiaSharp.SKPathAddMode)">
|
|
<param name="other">The path containing the elements to be added to the current path.</param>
|
|
<param name="matrix">Transformation matrix applied to the <paramref name="other" /> path.</param>
|
|
<param name="mode">Determines how the <paramref name="other" /> path contours are added to the path. On <see cref="F:SkiaSharp.SKPathAddMode.Append" /> mode, contours are added as new contours. On <see cref="F:SkiaSharp.SKPathAddMode.Extend" /> mode, the last contour of the path is extended with the first contour of the <paramref name="other" /> path.</param>
|
|
<summary>Extends the current path with the path elements from another path, by applying the specified transformation matrix, using the specified extension mode.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddPath(SkiaSharp.SKPath,System.Single,System.Single,SkiaSharp.SKPathAddMode)">
|
|
<param name="other">The path containing the elements to be added to the current path.</param>
|
|
<param name="dx">The amount to translate the path in X as it is added.</param>
|
|
<param name="dy">The amount to translate the path in Y as it is added.</param>
|
|
<param name="mode">Determines how the <paramref name="other" /> path contours are added to the path. On <see cref="F:SkiaSharp.SKPathAddMode.Append" /> mode, contours are added as new contours. On <see cref="F:SkiaSharp.SKPathAddMode.Extend" /> mode, the last contour of the path is extended with the first contour of the <paramref name="other" /> path.</param>
|
|
<summary>Extends the current path with the path elements from another path offset by (<paramref name="dx" />, <paramref name="dy" />), using the specified extension mode.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddPathReverse(SkiaSharp.SKPath)">
|
|
<param name="other">The path containing the elements to be added to the current path.</param>
|
|
<summary>Extends the current path with the path elements from another path in reverse order.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddPoly(SkiaSharp.SKPoint[],System.Boolean)">
|
|
<param name="points">The points that make up the polygon.</param>
|
|
<param name="close">Whether or not to close the path.</param>
|
|
<summary>Adds a new contour made of just lines.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddRect(SkiaSharp.SKRect,SkiaSharp.SKPathDirection)">
|
|
<param name="rect">The rectangle to add as a closed contour to the path</param>
|
|
<param name="direction">The direction to wind the rectangle's contour.</param>
|
|
<summary>Adds a closed rectangle contour to the path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddRect(SkiaSharp.SKRect,SkiaSharp.SKPathDirection,System.UInt32)">
|
|
<param name="rect">The rectangle to add as a closed contour to the path</param>
|
|
<param name="direction">The direction to wind the rectangle's contour.</param>
|
|
<param name="startIndex">Initial point of the contour (initial <see cref="M:SkiaSharp.SKPath.MoveTo(SkiaSharp.SKPoint)" />), expressed as a corner index, starting in the upper-left position, clock-wise. Must be in the range of 0..3.</param>
|
|
<summary>Adds a closed rectangle contour to the path.</summary>
|
|
<remarks>Add a closed rectangle contour to the path with an initial point of the contour (startIndex) expressed as a corner index.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddRoundedRect(SkiaSharp.SKRect,System.Single,System.Single,SkiaSharp.SKPathDirection)">
|
|
<param name="rect">The bounds of a the rounded rectangle.</param>
|
|
<param name="rx">The x-radius of the rounded corners.</param>
|
|
<param name="ry">The y-radius of the rounded corners</param>
|
|
<param name="dir">The direction to wind the rectangle's contour.</param>
|
|
<summary>Adds a closed rectangle with rounded corners to the current path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddRoundRect(SkiaSharp.SKRoundRect,SkiaSharp.SKPathDirection)">
|
|
<param name="rect">The rounded rectangle.</param>
|
|
<param name="direction">The direction to wind the rectangle's contour.</param>
|
|
<summary>Adds a closed rectangle with rounded corners to the current path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddRoundRect(SkiaSharp.SKRoundRect,SkiaSharp.SKPathDirection,System.UInt32)">
|
|
<param name="rect">The rounded rectangle.</param>
|
|
<param name="direction">The direction to wind the rectangle's contour.</param>
|
|
<param name="startIndex">Initial point of the contour (initial <see cref="M:SkiaSharp.SKPath.MoveTo(SkiaSharp.SKPoint)" />), expressed as an index of the radii minor/major points, ordered clock-wise. Must be in the range of 0..7.</param>
|
|
<summary>Adds a closed rectangle with rounded corners to the current path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.AddRoundRect(SkiaSharp.SKRect,System.Single,System.Single,SkiaSharp.SKPathDirection)">
|
|
<param name="rect">The bounds of a the rounded rectangle.</param>
|
|
<param name="rx">The x-radius of the rounded corners.</param>
|
|
<param name="ry">The y-radius of the rounded corners</param>
|
|
<param name="dir">The direction to wind the rectangle's contour.</param>
|
|
<summary>Adds a closed rectangle with rounded corners to the current path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ArcTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)">
|
|
<param name="point1">The corner coordinates.</param>
|
|
<param name="point2">The destination coordinates.</param>
|
|
<param name="radius">The corner radius.</param>
|
|
<summary>Appends a line and arc to the current path.</summary>
|
|
<remarks>This is the same as the PostScript call "arct".</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ArcTo(SkiaSharp.SKRect,System.Single,System.Single,System.Boolean)">
|
|
<param name="oval">The bounding oval defining the shape and size of the arc.</param>
|
|
<param name="startAngle">The starting angle (in degrees) where the arc begins.</param>
|
|
<param name="sweepAngle">The sweep angle (in degrees) measured clockwise.</param>
|
|
<param name="forceMoveTo">Whether to always begin a new contour with the arc.</param>
|
|
<summary>Appends the specified arc to the path.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If the start of the arc is different from the path's current last point, then
|
|
an automatic <xref:SkiaSharp.SKPath.LineTo%2A> is added to connect the current
|
|
contour to the start of the arc. However, if the path is empty, then we call
|
|
<xref:SkiaSharp.SKPath.MoveTo%2A> with the first point of the arc.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ArcTo(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,SkiaSharp.SKPoint)">
|
|
<param name="r">The radius.</param>
|
|
<param name="xAxisRotate">The angle in degrees relative to the x-axis.</param>
|
|
<param name="largeArc">Determines whether the smallest or largest arc possible is drawn.</param>
|
|
<param name="sweep">Determines if the arc should be swept in an anti-clockwise or clockwise direction.</param>
|
|
<param name="xy">The destination coordinate.</param>
|
|
<summary>Appends an elliptical arc from the current point in the format used by SVG.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ArcTo(System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x1">The corner x-coordinate.</param>
|
|
<param name="y1">The corner y-coordinate.</param>
|
|
<param name="x2">The destination x-coordinate.</param>
|
|
<param name="y2">The destination y-coordinate.</param>
|
|
<param name="radius">The corner radius.</param>
|
|
<summary>Appends a line and arc to the current path.</summary>
|
|
<remarks>This is the same as the PostScript call "arct".</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ArcTo(System.Single,System.Single,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,System.Single,System.Single)">
|
|
<param name="rx">The radius in the x-direction.</param>
|
|
<param name="ry">The radius in the y-direction.</param>
|
|
<param name="xAxisRotate">The angle in degrees relative to the x-axis.</param>
|
|
<param name="largeArc">Determines whether the smallest or largest arc possible is drawn.</param>
|
|
<param name="sweep">Determines if the arc should be swept in an anti-clockwise or clockwise direction.</param>
|
|
<param name="x">The destination x-coordinate.</param>
|
|
<param name="y">The destination y-coordinate.</param>
|
|
<summary>Appends an elliptical arc from the current point in the format used by SVG.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.Bounds">
|
|
<summary>Gets the bounds of the path's points. If the path contains zero points/verbs, this will return the empty rectangle.</summary>
|
|
<value>Gets the bounds of the path's points.</value>
|
|
<remarks>This bounds may be larger than the actual shape, since curves do not extend as far as their control points. Additionally this bound encompasses all points, even isolated MoveTo either preceding or following the last non-degenerate contour.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Close">
|
|
<summary>Closes the current contour.</summary>
|
|
<remarks>If the current point is not equal to the first point of the contour, a line segment is automatically added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ComputeTightBounds">
|
|
<summary>Computes a bounds that is conservatively "snug" around the path.</summary>
|
|
<returns>Returns the bounds.</returns>
|
|
<remarks>
|
|
<para>This assumes that the path will be filled.</para>
|
|
<para />
|
|
<para>It does not attempt to collapse away contours that are logically empty (e.g. MoveTo(x, y) + LineTo(x, y)) but will include them in the calculation.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ConicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)">
|
|
<param name="point0">The coordinates of the control point of the conic curve.</param>
|
|
<param name="point1">The coordinates of the end point of the conic curve.</param>
|
|
<param name="w">The weight of the conic curve.</param>
|
|
<summary>Add a conic path from the last point.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ConicTo(System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x0">The x-coordinate of the control point of the conic curve.</param>
|
|
<param name="y0">The y-coordinate of the control point of the conic curve.</param>
|
|
<param name="x1">The x-coordinate of the end point of the conic curve.</param>
|
|
<param name="y1">The y-coordinate of the end point of the conic curve.</param>
|
|
<param name="w">The weight of the conic curve.</param>
|
|
<summary>Add a conic path from the last point.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Contains(System.Single,System.Single)">
|
|
<param name="x">The x-coordinate to check.</param>
|
|
<param name="y">The y-coordinate to check.</param>
|
|
<summary>Returns true if the point (x, y) is contained by the path, taking into account the <see cref="P:SkiaSharp.SKPath.FillType" />.</summary>
|
|
<returns>Returns true if the point (x, y) is contained by the path.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ConvertConicToQuads(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single,System.Int32)">
|
|
<param name="p0">The coordinates of the starting point of the conic curve.</param>
|
|
<param name="p1">The coordinates of the control point of the conic curve.</param>
|
|
<param name="p2">The coordinates of the end point of the conic curve.</param>
|
|
<param name="w">The weight of the conic curve.</param>
|
|
<param name="pow2">The tolerance to use (1 << pow2).</param>
|
|
<summary>Chop a conic into a number of quads.</summary>
|
|
<returns>Returns the collection of points that make up the conic curve.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ConvertConicToQuads(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPoint[],System.Int32)">
|
|
<param name="p0">The coordinates of the starting point of the conic curve.</param>
|
|
<param name="p1">The coordinates of the control point of the conic curve.</param>
|
|
<param name="p2">The coordinates of the end point of the conic curve.</param>
|
|
<param name="w">The weight of the conic curve.</param>
|
|
<param name="pts">The collection to store the points.</param>
|
|
<param name="pow2">The tolerance to use (1 << pow2).</param>
|
|
<summary>Chop a conic into a number of quads.</summary>
|
|
<returns>Returns the number of quads.</returns>
|
|
<remarks>The amount of storage needed for pts is: 1 + 2 * (1 << pow2)</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ConvertConicToQuads(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPoint[]@,System.Int32)">
|
|
<param name="p0">The coordinates of the starting point of the conic curve.</param>
|
|
<param name="p1">The coordinates of the control point of the conic curve.</param>
|
|
<param name="p2">The coordinates of the end point of the conic curve.</param>
|
|
<param name="w">The weight of the conic curve.</param>
|
|
<param name="pts">The collection of points.</param>
|
|
<param name="pow2">The tolerance to use (1 << pow2).</param>
|
|
<summary>Chop a conic into a number of quads.</summary>
|
|
<returns>Returns the number of quads.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.Convexity">
|
|
<summary>Gets or sets the path's convexity.</summary>
|
|
<value />
|
|
<remarks>If it is currently unknown, then this function will attempt to compute the convexity (and cache the result).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.CreateIterator(System.Boolean)">
|
|
<param name="forceClose">When this is true, each contour (as defined by a new starting move command) will be completed with a close verb regardless of the contour's contents.</param>
|
|
<summary>Creates an iterator object to scan the all of the segments (lines, quadratics, cubics) of each contours in a path.</summary>
|
|
<returns>Returns an object that can be used to iterate over the various elements of the path.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This iterator is able to clean up the path as the values are returned. If you
|
|
do not desire to get verbs that have been cleaned up, use the
|
|
<xref:SkiaSharp.SKPath.CreateRawIterator%2A> method instead.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.CreateRawIterator">
|
|
<summary>Creates a raw iterator object to scan the all of the segments (lines, quadratics, cubics) of each contours in a path.</summary>
|
|
<returns>Returns an object that can be used to iterate over the various elements of the path.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Unlike the <xref:SkiaSharp.SKPath.CreateIterator%2A> method, this iterator
|
|
does not clean up or normalize the values in the path. It returns the raw
|
|
elements contained in the path.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.CubicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="point0">The coordinates of the 1st control point on a cubic curve.</param>
|
|
<param name="point1">The coordinates of the 2nd control point on a cubic curve.</param>
|
|
<param name="point2">The coordinates of the end point on a cubic curve.</param>
|
|
<summary>Adds a cubic bezier from the last point.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.CubicTo(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x0">The x-coordinate of the 1st control point on a cubic curve.</param>
|
|
<param name="y0">The y-coordinate of the 1st control point on a cubic curve.</param>
|
|
<param name="x1">The x-coordinate of the 2nd control point on a cubic curve.</param>
|
|
<param name="y1">The y-coordinate of the 2nd control point on a cubic curve.</param>
|
|
<param name="x2">The x-coordinate of the end point on a cubic curve.</param>
|
|
<param name="y2">The y-coordinate of the end point on a cubic curve.</param>
|
|
<summary>Adds a cubic bezier from the last point.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPath" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPath" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.FillType">
|
|
<summary>Gets or sets the path's fill type.</summary>
|
|
<value />
|
|
<remarks>This is used to define how "inside" is computed. The default value is <see cref="F:SkiaSharp.SKPathFillType.Winding" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetBounds(SkiaSharp.SKRect@)">
|
|
<param name="rect">The bounds, if the path contains any points.</param>
|
|
<summary>Returns the bounds of the path's points.</summary>
|
|
<returns>Returns true if the path is not empty, otherwise false.</returns>
|
|
<remarks>This bounds may be larger than the actual shape, since curves do not extend as far as their control points. Additionally this bound encompasses all points, even isolated MoveTo either preceding or following the last non-degenerate contour.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetLine">
|
|
<summary>Returns the two points of the path.</summary>
|
|
<returns>Returns the two points of the path.</returns>
|
|
<remarks>If the path is not a single, straight line, then <see langword="null" /> is returned. See also <see cref="P:SkiaSharp.SKPath.IsLine" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetOvalBounds">
|
|
<summary>Returns the oval bounds of the path.</summary>
|
|
<returns>Returns the oval bounds of the path.</returns>
|
|
<remarks>If the path is not a single oval or circle, then an empty rectangle is returned. See also <see cref="P:SkiaSharp.SKPath.IsOval" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetPoint(System.Int32)">
|
|
<param name="index">The index of the point to return.</param>
|
|
<summary>Returns the point at the specified index.</summary>
|
|
<returns>The point at the specified index.</returns>
|
|
<remarks>If the index is out of range (i.e. is not 0 <= index < <see cref="P:SkiaSharp.SKPath.PointCount" />), then the returned coordinates will be (0, 0).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetPoints(System.Int32)">
|
|
<param name="max">The maximum number of points to copy into points.</param>
|
|
<summary>Returns a subset of points in the path. Up to max points are copied.</summary>
|
|
<returns>Returns the requested set of points.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetPoints(SkiaSharp.SKPoint[],System.Int32)">
|
|
<param name="points">The array to hold the points.</param>
|
|
<param name="max">The maximum number of points to copy into points.</param>
|
|
<summary>Returns a subset of points in the path. Up to max points are copied.</summary>
|
|
<returns>Returns the actual number of points in the path</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetRect">
|
|
<summary>Returns the rectangle of the path.</summary>
|
|
<returns>Returns the rectangle of the path.</returns>
|
|
<remarks>If the path is not a single rectangle, then an empty rectangle is returned. See also <see cref="P:SkiaSharp.SKPath.IsRect" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetRect(System.Boolean@,SkiaSharp.SKPathDirection@)">
|
|
<param name="isClosed">Whether or not the rectangle is closed.</param>
|
|
<param name="direction">The direction of the rectangle.</param>
|
|
<summary>Returns the rectangle of the path.</summary>
|
|
<returns>Returns the rectangle of the path.</returns>
|
|
<remarks>If the path is not a single rectangle, then an empty rectangle is returned. See also <see cref="P:SkiaSharp.SKPath.IsRect" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetRoundRect">
|
|
<summary>Returns the round rectangle of the path.</summary>
|
|
<returns>Returns the round rectangle of the path.</returns>
|
|
<remarks>If the path is not a single round rectangle, then <see langword="null" /> is returned. See also <see cref="P:SkiaSharp.SKPath.IsRoundRect" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.GetTightBounds(SkiaSharp.SKRect@)">
|
|
<param name="result">The tight bounds of the path.</param>
|
|
<summary>Gets the "tight" bounds of the path. Unlike <see cref="M:SkiaSharp.SKPath.GetBounds(SkiaSharp.SKRect@)" />, the control points of curves are excluded.</summary>
|
|
<returns>Returns true if the bounds could be computed, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.IsConcave">
|
|
<summary>Gets a value indicating whether the path is concave.</summary>
|
|
<value />
|
|
<remarks>If it is currently unknown, then this function will attempt to compute the convexity (and cache the result).</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.IsConvex">
|
|
<summary>Gets a value indicating whether the path is convex.</summary>
|
|
<value />
|
|
<remarks>If it is currently unknown, then this function will attempt to compute the convexity (and cache the result).</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.IsEmpty">
|
|
<summary>Gets a value indicating whether or not the path is empty (contains no lines or curves).</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.IsLine">
|
|
<summary>Gets a value indicating whether the path is a single, straight line.</summary>
|
|
<value />
|
|
<remarks>See also <see cref="M:SkiaSharp.SKPath.GetLine" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.IsOval">
|
|
<summary>Gets a value indicating whether the path is a single oval or circle.</summary>
|
|
<value />
|
|
<remarks>See also <see cref="M:SkiaSharp.SKPath.GetOvalBounds" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.IsRect">
|
|
<summary>Gets a value indicating whether the path is a single rectangle.</summary>
|
|
<value />
|
|
<remarks>See also <see cref="M:SkiaSharp.SKPath.GetRect" /> and <see cref="M:SkiaSharp.SKPath.GetRect(System.Boolean@,SkiaSharp.SKPathDirection@)" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.IsRoundRect">
|
|
<summary>Gets a value indicating whether the path is a single, round rectangle.</summary>
|
|
<value />
|
|
<remarks>See also <see cref="M:SkiaSharp.SKPath.GetRoundRect" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.Item(System.Int32)">
|
|
<param name="index">The index of the point to get.</param>
|
|
<summary>Gets the point at the specified index.</summary>
|
|
<value>The point at the specified index.</value>
|
|
<remarks>If the index is out of range (i.e. is not 0 <= index < <see cref="P:SkiaSharp.SKPath.PointCount" />), then the returned coordinates will be (0, 0).</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.LastPoint">
|
|
<summary>Return the last point on the path. If no points have been added, (0, 0) is returned.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.LineTo(SkiaSharp.SKPoint)">
|
|
<param name="point">The coordinates of the end of a line.</param>
|
|
<summary>Add a line from the last point to the specified point (x, y).</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.LineTo(System.Single,System.Single)">
|
|
<param name="x">The x-coordinate of the end of a line.</param>
|
|
<param name="y">The y-coordinate of the end of a line.</param>
|
|
<summary>Add a line from the last point to the specified point (x, y).</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.MoveTo(SkiaSharp.SKPoint)">
|
|
<param name="point">The coordinates of the start of a new contour.</param>
|
|
<summary>Set the beginning of the next contour to the point.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.MoveTo(System.Single,System.Single)">
|
|
<param name="x">The x-coordinate of the start of a new contour.</param>
|
|
<param name="y">The y-coordinate of the start of a new contour.</param>
|
|
<summary>Set the beginning of the next contour to the point.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Offset(SkiaSharp.SKPoint)">
|
|
<param name="offset">The amount to offset the entire path.</param>
|
|
<summary>Set the beginning of the next contour to the point.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Offset(System.Single,System.Single)">
|
|
<param name="dx">The amount in the x-direction to offset the entire path.</param>
|
|
<param name="dy">The amount in the y-direction to offset the entire path.</param>
|
|
<summary>Offset the path by the specified distance.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Op(SkiaSharp.SKPath,SkiaSharp.SKPathOp)">
|
|
<param name="other">The second operand.</param>
|
|
<param name="op">The logical operator.</param>
|
|
<summary>Compute the result of a logical operation on two paths.</summary>
|
|
<returns>Returns the resulting path if the operation was successful, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Op(SkiaSharp.SKPath,SkiaSharp.SKPathOp,SkiaSharp.SKPath)">
|
|
<param name="other">The second operand.</param>
|
|
<param name="op">The logical operator.</param>
|
|
<param name="result">The path that will be used to set the result to. The current path will be <see cref="M:SkiaSharp.SKPath.Reset" />.</param>
|
|
<summary>Compute the result of a logical operation on two paths.</summary>
|
|
<returns>Returns true if the operation was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ParseSvgPathData(System.String)">
|
|
<param name="svgPath">The SVG path data.</param>
|
|
<summary>Creates a path based on the SVG path data string.</summary>
|
|
<returns>Returns the new path if successful, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.PointCount">
|
|
<summary>Gets the number of points on the path.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.Points">
|
|
<summary>Gets all the points in the path.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The number of points will be <xref:SkiaSharp.SKPath.PointCount>, To only
|
|
return a subset of the points in the path, use
|
|
<xref:SkiaSharp.SKPath.GetPoints%2A>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.QuadTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="point0">The coordinates of the control point on a quadratic curve.</param>
|
|
<param name="point1">The coordinates of the end point on a quadratic curve.</param>
|
|
<summary>Add a quadratic bezier from the last point.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Add a quadratic bezier from the last point, approaching control point
|
|
(`point0`), and ending at `point1`.
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.QuadTo(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x0">The x-coordinate of the control point on a quadratic curve.</param>
|
|
<param name="y0">The y-coordinate of the control point on a quadratic curve.</param>
|
|
<param name="x1">The x-coordinate of the end point on a quadratic curve.</param>
|
|
<param name="y1">The y-coordinate of the end point on a quadratic curve.</param>
|
|
<summary>Add a quadratic bezier from the last point.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Add a quadratic bezier from the last point, approaching control point
|
|
(`x0`, `y0`), and ending at (`x1`, `y1`).
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RArcTo(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,SkiaSharp.SKPoint)">
|
|
<param name="r">The radius.</param>
|
|
<param name="xAxisRotate">The angle in degrees relative to the x-axis.</param>
|
|
<param name="largeArc">Determines whether the smallest or largest arc possible is drawn.</param>
|
|
<param name="sweep">Determines if the arc should be swept in an anti-clockwise or clockwise direction.</param>
|
|
<param name="xy">The destination coordinates relative to the last point.</param>
|
|
<summary>The same as <see cref="M:SkiaSharp.SKPath.ArcTo(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,SkiaSharp.SKPoint)" />, but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RArcTo(System.Single,System.Single,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,System.Single,System.Single)">
|
|
<param name="rx">The radius in the x-direction.</param>
|
|
<param name="ry">The radius in the y-direction.</param>
|
|
<param name="xAxisRotate">The angle in degrees relative to the x-axis.</param>
|
|
<param name="largeArc">Determines whether the smallest or largest arc possible is drawn.</param>
|
|
<param name="sweep">Determines if the arc should be swept in an anti-clockwise or clockwise direction.</param>
|
|
<param name="x">The destination x-coordinate relative to the last point.</param>
|
|
<param name="y">The destination y-coordinate relative to the last point.</param>
|
|
<summary>The same as <see cref="M:SkiaSharp.SKPath.ArcTo(System.Single,System.Single,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,System.Single,System.Single)" />, but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RConicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)">
|
|
<param name="point0">The amount to add to the coordinates of the last point on this contour, to specify the control point of the conic curve.</param>
|
|
<param name="point1">The amount to add to the coordinates of the last point on this contour, to specify the end point of the conic curve.</param>
|
|
<param name="w">The weight of the conic curve.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.ConicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RConicTo(System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="dx0">The amount to add to the x-coordinate of the last point on this contour, to specify the control point of the conic curve.</param>
|
|
<param name="dy0">The amount to add to the y-coordinate of the last point on this contour, to specify the control point of the conic curve.</param>
|
|
<param name="dx1">The amount to add to the x-coordinate of the last point on this contour, to specify the end point of the conic curve.</param>
|
|
<param name="dy1">The amount to add to the y-coordinate of the last point on this contour, to specify the end point of the conic curve.</param>
|
|
<param name="w">The weight of the conic curve.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.ConicTo(System.Single,System.Single,System.Single,System.Single,System.Single)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RCubicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="point0">The amount to add to the coordinates of the last point on this contour, to specify the 1st control point on a cubic curve.</param>
|
|
<param name="point1">The amount to add to the coordinates of the last point on this contour, to specify the 2nd control point on a cubic curve.</param>
|
|
<param name="point2">The amount to add to the coordinates of the last point on this contour, to specify the end point on a cubic curve.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.CubicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RCubicTo(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="dx0">The amount to add to the x-coordinate of the last point on this contour, to specify the 1st control point on a cubic curve.</param>
|
|
<param name="dy0">The amount to add to the y-coordinate of the last point on this contour, to specify the 1st control point on a cubic curve.</param>
|
|
<param name="dx1">The amount to add to the x-coordinate of the last point on this contour, to specify the 2nd control point on a cubic curve.</param>
|
|
<param name="dy1">The amount to add to the y-coordinate of the last point on this contour, to specify the 2nd control point on a cubic curve.</param>
|
|
<param name="dx2">The amount to add to the x-coordinate of the last point on this contour, to specify the end point on a cubic curve.</param>
|
|
<param name="dy2">The amount to add to the y-coordinate of the last point on this contour, to specify the end point on a cubic curve.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.CubicTo(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Reset">
|
|
<summary>Clear any lines and curves from the path, making it empty.</summary>
|
|
<remarks>This frees up internal storage associated with those segments.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Rewind">
|
|
<summary>Clear any lines and curves from the path, making it empty.</summary>
|
|
<remarks>Any internal storage for those lines/curves is retained, making reuse of the path potentially faster.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RLineTo(SkiaSharp.SKPoint)">
|
|
<param name="point">The amount to add to the coordinates of the last point on this contour, to specify the end of a line.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.LineTo(SkiaSharp.SKPoint)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RLineTo(System.Single,System.Single)">
|
|
<param name="dx">The amount to add to the x-coordinate of the last point on this contour, to specify the end of a line.</param>
|
|
<param name="dy">The amount to add to the y-coordinate of the last point on this contour, to specify the end of a line.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.LineTo(System.Single,System.Single)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RMoveTo(SkiaSharp.SKPoint)">
|
|
<param name="point">The amount to add to the coordinates of the last point on this contour, to specify the start of a new contour.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.MoveTo(SkiaSharp.SKPoint)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RMoveTo(System.Single,System.Single)">
|
|
<param name="dx">The amount to add to the x-coordinate of the last point on this contour, to specify the start of a new contour.</param>
|
|
<param name="dy">The amount to add to the x-coordinate of the last point on this contour, to specify the start of a new contour.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.MoveTo(System.Single,System.Single)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RQuadTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="point0">The amount to add to the coordinates of the last point on this contour, to specify the control point on a quadratic curve.</param>
|
|
<param name="point1">The amount to add to the coordinates of the last point on this contour, to specify end point on a quadratic curve.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.QuadTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.RQuadTo(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="dx0">The amount to add to the x-coordinate of the last point on this contour, to specify the control point on a quadratic curve.</param>
|
|
<param name="dy0">The amount to add to the y-coordinate of the last point on this contour, to specify the control point on a quadratic curve.</param>
|
|
<param name="dx1">The amount to add to the x-coordinate of the last point on this contour, to specify end point on a quadratic curve.</param>
|
|
<param name="dy1">The amount to add to the y-coordinate of the last point on this contour, to specify end point on a quadratic curve.</param>
|
|
<summary>Same as <see cref="M:SkiaSharp.SKPath.QuadTo(System.Single,System.Single,System.Single,System.Single)" /> but the coordinates are considered relative to the last point on this contour.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If no <xref:SkiaSharp.SKPath.MoveTo%2A> call has been made for this contour,
|
|
the first point is automatically set to (0, 0).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.SegmentMasks">
|
|
<summary>Gets a set of flags indicating if the path contains one or more segments of that type.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Simplify">
|
|
<summary>Return a simplified copy of the current path.</summary>
|
|
<returns>Returns the new path if simplification was successful, otherwise null.</returns>
|
|
<remarks>The curve order is reduced where possible so that cubics may be turned into quadratics, and quadratics maybe turned into lines.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Simplify(SkiaSharp.SKPath)">
|
|
<param name="result">The path to store the simplified path data. If simplification failed, then this is unmodified.</param>
|
|
<summary>Simplifies the current path.</summary>
|
|
<returns>Returns true if simplification was successful, otherwise false.</returns>
|
|
<remarks>The curve order is reduced where possible so that cubics may be turned into quadratics, and quadratics maybe turned into lines.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.TightBounds">
|
|
<summary>Gets the "tight" bounds of the path. Unlike <see cref="P:SkiaSharp.SKPath.Bounds" />, the control points of curves are excluded.</summary>
|
|
<value>The tight bounds of the path.</value>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ToSvgPathData">
|
|
<summary>Returns a SVG path data representation of the current path.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ToWinding">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.ToWinding(SkiaSharp.SKPath)">
|
|
<param name="result">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Transform(SkiaSharp.SKMatrix)">
|
|
<param name="matrix">The matrix to use for transformation.</param>
|
|
<summary>Applies a transformation matrix to the all the elements in the path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath.Transform(SkiaSharp.SKMatrix,SkiaSharp.SKPath)">
|
|
<param name="matrix">The matrix to use for transformation.</param>
|
|
<param name="destination">The instance that should contain the final, transformed path.</param>
|
|
<summary>Applies a transformation matrix to the all the elements in the path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPath.VerbCount">
|
|
<summary>Gets the number of verbs in the path.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPath+Iterator">
|
|
<summary>Iterator object to scan the all of the segments (lines, quadratics, cubics) of each contours in a path.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Iterators are created by calling the
|
|
<xref:SkiaSharp.SKPath.CreateIterator%2A?displayProperty=nameWithType> method.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+Iterator.ConicWeight">
|
|
<summary>Return the weight for the current conic.</summary>
|
|
<returns />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Only valid if the current segment return by
|
|
<xref:SkiaSharp.SKPath.Iterator.Next%2A> was <xref:SkiaSharp.SKPathVerb.Conic>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+Iterator.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPath.Iterator" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPath.Iterator" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+Iterator.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+Iterator.IsCloseContour">
|
|
<summary>Returns a value indicating whether the current contour is closed.</summary>
|
|
<returns>Returns true if the current contour is closed (has a <see cref="E:SkiaSharp.SKPathVerb.Close" />).</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+Iterator.IsCloseLine">
|
|
<summary>Returns a value indicating whether the last call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> returns a line which was the result of a <see cref="M:SkiaSharp.SKPath.Close" /> command.</summary>
|
|
<returns>Returns true if the last call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> returned a line which was the result of a <see cref="M:SkiaSharp.SKPath.Close" /> command.</returns>
|
|
<remarks>If the call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> returned a different value than <see cref="F:SkiaSharp.SKPathVerb.Line" />, the result is undefined.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+Iterator.Next(SkiaSharp.SKPoint[])">
|
|
<param name="points">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+Iterator.Next(System.Span{SkiaSharp.SKPoint})">
|
|
<param name="points">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)">
|
|
<param name="points">The storage for the points representing the current verb and/or segment. Should be an array of four points.</param>
|
|
<param name="doConsumeDegenerates">If <see langword="true" />, first scan for segments that are deemed degenerate (too short) and skip those.</param>
|
|
<param name="exact">If <paramref name="doConsumeDegenerates" /> is <see langword="true" /> and exact is true, skip only degenerate elements with lengths exactly equal to zero. If exact is <see langword="false" />, skip degenerate elements with lengths close to zero. If <paramref name="doConsumeDegenerates" /> is <see langword="false" />, exact has no effect.</param>
|
|
<summary>Returns the next verb in this iteration of the path.</summary>
|
|
<returns>The verb of the current segment.</returns>
|
|
<remarks>When all segments have been visited, returns <see cref="F:SkiaSharp.SKPathVerb.Done" />.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPath+OpBuilder">
|
|
<summary>Perform a series of path operations, optimized for unioning many paths together.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPath+OpBuilder">
|
|
<summary>Creates an instance of <see cref="T:SkiaSharp.SKPath.OpBuilder" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+OpBuilder.Add(SkiaSharp.SKPath,SkiaSharp.SKPathOp)">
|
|
<param name="path">The second operand.</param>
|
|
<param name="op">The operator to apply to the existing and supplied paths.</param>
|
|
<summary>Add one or more paths and their operand.</summary>
|
|
<remarks>The builder is empty before the first path is added, so the result of a single add is ("empty-path" OP "path").</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+OpBuilder.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPath.OpBuilder" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPath.OpBuilder" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+OpBuilder.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+OpBuilder.Resolve(SkiaSharp.SKPath)">
|
|
<param name="result">The product of the operands.</param>
|
|
<summary>Computes the sum of all paths and operands, and resets the builder to its initial state.</summary>
|
|
<returns>Returns true if the operation succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPath+RawIterator">
|
|
<summary>Iterator object to scan through the verbs in the path, providing the associated points.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Iterators are created by calling the
|
|
<xref:SkiaSharp.SKPath.CreateRawIterator%2A?displayProperty=nameWithType>
|
|
method.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+RawIterator.ConicWeight">
|
|
<summary>Returns the weight for the current conic.</summary>
|
|
<returns />
|
|
<remarks>Only valid if the current segment returned by <see cref="M:SkiaSharp.SKPath.RawIterator.Next(SkiaSharp.SKPoint[])" /> was <see cref="F:SkiaSharp.SKPathVerb.Conic" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+RawIterator.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPath.RawIterator" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPath.RawIterator" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+RawIterator.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+RawIterator.Next(SkiaSharp.SKPoint[])">
|
|
<param name="points">The storage for the points representing the current verb and/or segment. Should be an array of four points.</param>
|
|
<summary>Returns the next verb in this iteration of the path.</summary>
|
|
<returns>The verb of the current segment.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+RawIterator.Next(System.Span{SkiaSharp.SKPoint})">
|
|
<param name="points">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPath+RawIterator.Peek">
|
|
<summary>Returns what the next verb will be, but do not visit the next segment.</summary>
|
|
<returns>Returns the verb for the next segment.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPath1DPathEffectStyle">
|
|
<summary>How to transform path at each point (based on the current position and tangent).</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPath1DPathEffectStyle.Morph">
|
|
<summary>Transform each point, and turn lines into curves.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPath1DPathEffectStyle.Rotate">
|
|
<summary>Rotate the shape about its center.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPath1DPathEffectStyle.Translate">
|
|
<summary>Translate the shape to each position.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathAddMode">
|
|
<summary>Controls how a path is added to another path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathAddMode.Append">
|
|
<summary>Source path contours are added as new contours.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathAddMode.Extend">
|
|
<summary>The path is added by extending the last contour of the destination path with the first contour of the source path. If the last contour of the destination path is closed, then it will not be extended. Instead, the start of source path will be extended by a straight line to the end point of the destination path.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathArcSize">
|
|
<summary>Indication for whether the smaller or larger of possible two arcs is drawn.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathArcSize.Large">
|
|
<summary>The larger of the two possible arcs.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathArcSize.Small">
|
|
<summary>The smaller of the two possible arcs.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathConvexity">
|
|
<summary>Convexity for paths.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathConvexity.Concave">
|
|
<summary>The path is concave.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathConvexity.Convex">
|
|
<summary>The path is convex.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathConvexity.Unknown">
|
|
<summary>The path's convexity is unknown.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathDirection">
|
|
<summary>Direction for path contours.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathDirection.Clockwise">
|
|
<summary>Clockwise direction for adding closed contours.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathDirection.CounterClockwise">
|
|
<summary>Counter-clockwise direction for adding closed contours.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathEffect">
|
|
<summary>The base class for objects in the <see cref="T:SkiaSharp.SKPaint" /> that affect the geometry of a drawing primitive before it is transformed by the canvas' matrix and drawn.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.Create1DPath(SkiaSharp.SKPath,System.Single,System.Single,SkiaSharp.SKPath1DPathEffectStyle)">
|
|
<param name="path">The path to replicate (dash).</param>
|
|
<param name="advance">The space between instances of path.</param>
|
|
<param name="phase">The distance (mod advance) along path for its initial position.</param>
|
|
<param name="style">How to transform path at each point (based on the current position and tangent).</param>
|
|
<summary>Creates a dash path effect by replicating the specified path.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.Create2DLine(System.Single,SkiaSharp.SKMatrix)">
|
|
<param name="width">The width of the line.</param>
|
|
<param name="matrix">The matrix.</param>
|
|
<summary>Creates a dash path effect by replacing the path with a solid line.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.Create2DPath(SkiaSharp.SKMatrix,SkiaSharp.SKPath)">
|
|
<param name="matrix">The matrix.</param>
|
|
<param name="path">The path.</param>
|
|
<summary>Stamp the specified path to fill the shape, using the matrix to define the latice.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.CreateArcTo(System.Single)">
|
|
<param name="radius">The arc radius.</param>
|
|
<summary>Creates a path effect that can turn sharp corners into various arcs.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.CreateCompose(SkiaSharp.SKPathEffect,SkiaSharp.SKPathEffect)">
|
|
<param name="outer">The outer (second) path effect to apply.</param>
|
|
<param name="inner">The inner (first) path effect to apply.</param>
|
|
<summary>Creates a compound path effect.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks>The effect is to apply first the inner path effect and the the outer path effect (e.g. outer(inner(path))).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.CreateCorner(System.Single)">
|
|
<param name="radius">The radius to use, must be > 0 to have an effect.</param>
|
|
<summary>Creates a path effect that can turn sharp corners into various treatments (e.g. rounded corners).</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.CreateDash(System.Single[],System.Single)">
|
|
<param name="intervals">The definition of the dash pattern via an even number of entries.</param>
|
|
<param name="phase">The offset into the intervals array. (mod the sum of all of the intervals).</param>
|
|
<summary>Creates a dash path effect by specifying the dash intervals.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks>
|
|
<para>The dash pattern is defined via an array containing an even number of entries (>=2), with the even indices specifying the length of "on" intervals, and the odd indices specifying the length of "off" intervals.</para>
|
|
<para>For example: if the intervals = new [] { 10, 20 } and the phase = 25, then the dash pattern will be: 5 pixels off, 10 pixels on, 20 pixels off, 10 pixels on, 20 pixels off, etc. A phase of -5, 25, 55, 85, etc. would all result in the same path, because the sum of all the intervals is 30.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.CreateDiscrete(System.Single,System.Single,System.UInt32)">
|
|
<param name="segLength">The length of the segments to break the path into.</param>
|
|
<param name="deviation">The maximum distance to move the point away from the original path.</param>
|
|
<param name="seedAssist">The randomizer seed to use.</param>
|
|
<summary>Creates a "jitter" path effect by chopping a path into discrete segments, and randomly displacing them.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.CreateSum(SkiaSharp.SKPathEffect,SkiaSharp.SKPathEffect)">
|
|
<param name="first">The first path effect to apply.</param>
|
|
<param name="second">The second path effect to apply.</param>
|
|
<summary>Creates a compound path effect.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks>The effect is to apply one path after the other.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.CreateTrim(System.Single,System.Single)">
|
|
<param name="start">The start path offset between [0, 1] - inclusive.</param>
|
|
<param name="stop">The stop path offset between [0, 1] - inclusive.</param>
|
|
<summary>Creates a path effect that trims the path.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks>If either the start or stop values are outside the [0, 1] range (inclusive), they will be pinned to the nearest legal value.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.CreateTrim(System.Single,System.Single,SkiaSharp.SKTrimPathEffectMode)">
|
|
<param name="start">The start path offset between [0, 1] - inclusive.</param>
|
|
<param name="stop">The stop path offset between [0, 1] - inclusive.</param>
|
|
<param name="mode">The trim mode to use.</param>
|
|
<summary>Creates a path effect that trims the path.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPathEffect" />, or null on error.</returns>
|
|
<remarks>If either the start or stop values are outside the [0, 1] range (inclusive), they will be pinned to the nearest legal value.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathEffect.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPathEffect" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPathEffect" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathFillType">
|
|
<summary>Possible path fill type values.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathFillType.EvenOdd">
|
|
<summary>Specifies that "inside" is computed by an odd number of edge crossings.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathFillType.InverseEvenOdd">
|
|
<summary>Same as <see cref="F:SkiaSharp.SKPathFillType.EvenOdd" />, but draws outside of the path, rather than inside.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathFillType.InverseWinding">
|
|
<summary>Same as <see cref="F:SkiaSharp.SKPathFillType.Winding" />, but draws outside of the path, rather than inside.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathFillType.Winding">
|
|
<summary>Specifies that "inside" is computed by a non-zero sum of signed edge crossings.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathMeasure">
|
|
<summary>Represents a type that can be used to calculate the length of, and segments of, a path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPathMeasure">
|
|
<summary>Create a new <see cref="T:SkiaSharp.SKPathMeasure" /> instance with a null path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPathMeasure(SkiaSharp.SKPath,System.Boolean,System.Single)">
|
|
<param name="path">The path to use, or null.</param>
|
|
<param name="forceClosed">Controls whether or not the path is treated as closed.</param>
|
|
<param name="resScale">Controls the precision of the measure. Values greater 1 increase the precision (and possibly slow down the computation).</param>
|
|
<summary>Create a new <see cref="T:SkiaSharp.SKPathMeasure" /> instance with the specified path.</summary>
|
|
<remarks>The path must remain valid for the lifetime of the measure object, or until <see cref="M:SkiaSharp.SKPathMeasure.SetPath(SkiaSharp.SKPath,System.Boolean)" /> is called with a different path (or null), since the measure object keeps a reference to the path object (does not copy its data).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPathMeasure" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPathMeasure" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.GetMatrix(System.Single,SkiaSharp.SKPathMeasureMatrixFlags)">
|
|
<param name="distance">To be added.</param>
|
|
<param name="flags">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.GetMatrix(System.Single,SkiaSharp.SKMatrix@,SkiaSharp.SKPathMeasureMatrixFlags)">
|
|
<param name="distance">The distance to use.</param>
|
|
<param name="matrix">The computed matrix.</param>
|
|
<param name="flags">Flags to indicate how to compute the matrix.</param>
|
|
<summary>Computes a <see cref="T:SkiaSharp.SKMatrix" /> from the specified distance along the path.</summary>
|
|
<returns>Returns false if there is no path, or a zero-length path was specified, in which case matrix is unchanged.</returns>
|
|
<remarks>Distance is pinned to 0 <= distance <= <see cref="P:SkiaSharp.SKPathMeasure.Length" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.GetPosition(System.Single)">
|
|
<param name="distance">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.GetPosition(System.Single,SkiaSharp.SKPoint@)">
|
|
<param name="distance">The distance to use.</param>
|
|
<param name="position">The position of a point along the current contour.</param>
|
|
<summary>Computes the corresponding position from the specified distance along the path.</summary>
|
|
<returns>Returns false if there is no path, or a zero-length path was specified, in which case position is unchanged.</returns>
|
|
<remarks>Distance is pinned to 0 <= distance <= <see cref="P:SkiaSharp.SKPathMeasure.Length" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.GetPositionAndTangent(System.Single,SkiaSharp.SKPoint@,SkiaSharp.SKPoint@)">
|
|
<param name="distance">The distance to use. </param>
|
|
<param name="position">The position of a point along the current contour.</param>
|
|
<param name="tangent">The tangent along the current contour.</param>
|
|
<summary>Computes the corresponding position and tangent from the specified distance along the path.</summary>
|
|
<returns>Returns false if there is no path, or a zero-length path was specified, in which case position and tangent are unchanged.</returns>
|
|
<remarks>Distance is pinned to 0 <= distance <= <see cref="P:SkiaSharp.SKPathMeasure.Length" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.GetSegment(System.Single,System.Single,System.Boolean)">
|
|
<param name="start">To be added.</param>
|
|
<param name="stop">To be added.</param>
|
|
<param name="startWithMoveTo">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.GetSegment(System.Single,System.Single,SkiaSharp.SKPath,System.Boolean)">
|
|
<param name="start">The starting offset of the segment.</param>
|
|
<param name="stop">The end offset of the segment.</param>
|
|
<param name="dst">The path to hold the new segment.</param>
|
|
<param name="startWithMoveTo">If true, begin the path segment with a <see cref="M:SkiaSharp.SKPath.MoveTo(SkiaSharp.SKPoint)" />.</param>
|
|
<summary>Given a start and stop distance, update the destination path with the intervening segment(s).</summary>
|
|
<returns>Returns false if the segment is zero-length, otherwise returns true.</returns>
|
|
<remarks>The start and stop parameters are pinned to 0..<see cref="P:SkiaSharp.SKPathMeasure.Length" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.GetTangent(System.Single)">
|
|
<param name="distance">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.GetTangent(System.Single,SkiaSharp.SKPoint@)">
|
|
<param name="distance">The distance to use.</param>
|
|
<param name="tangent">The tangent along the current contour.</param>
|
|
<summary>Computes the corresponding tangent from the specified distance along the path.</summary>
|
|
<returns>Returns false if there is no path, or a zero-length path was specified, in which case position and tangent are unchanged.</returns>
|
|
<remarks>Distance is pinned to 0 <= distance <= <see cref="P:SkiaSharp.SKPathMeasure.Length" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPathMeasure.IsClosed">
|
|
<summary>Gets a value indicating if the current contour is closed.</summary>
|
|
<value>Returns true if the current contour is closed.</value>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPathMeasure.Length">
|
|
<summary>Gets the total length of the current contour, or 0 if no path is associated.</summary>
|
|
<value>The total length of the current contour.</value>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.NextContour">
|
|
<summary>Move to the next contour in the path.</summary>
|
|
<returns>Returns true if another one exists, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.SetPath(SkiaSharp.SKPath)">
|
|
<param name="path">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPathMeasure.SetPath(SkiaSharp.SKPath,System.Boolean)">
|
|
<param name="path">The path to use, or null.</param>
|
|
<param name="forceClosed">Controls whether or not the path is treated as closed.</param>
|
|
<summary>Reset the path measure with the specified path.</summary>
|
|
<remarks>The path must remain valid for the lifetime of the measure object, or until <see cref="M:SkiaSharp.SKPathMeasure.SetPath(SkiaSharp.SKPath,System.Boolean)" /> is called with a different path (or null), since the measure object keeps a reference to the path object (does not copy its data).</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathMeasureMatrixFlags">
|
|
<summary>Flags to indicate how to compute a matrix from a position along a path.</summary>
|
|
<remarks>This is used with <see cref="M:SkiaSharp.SKPathMeasure.GetMatrix(System.Single,SkiaSharp.SKMatrix@,SkiaSharp.SKPathMeasureMatrixFlags)" />.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathMeasureMatrixFlags.GetPosition">
|
|
<summary>Use the coordinates of the point along the path.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathMeasureMatrixFlags.GetPositionAndTangent">
|
|
<summary>Use the coordinates of the point and the tangent along the path.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathMeasureMatrixFlags.GetTangent">
|
|
<summary>Use the coordinates of the tangent along the path.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathOp">
|
|
<summary>The logical operations that can be performed when combining two paths using <see cref="M:SkiaSharp.SKPath.Op(SkiaSharp.SKPath,SkiaSharp.SKPathOp)" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathOp.Difference">
|
|
<summary>Subtract the op path from the current path.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathOp.Intersect">
|
|
<summary>Intersect the two paths.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathOp.ReverseDifference">
|
|
<summary>Subtract the current path from the op path.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathOp.Union">
|
|
<summary>Union (inclusive-or) the two paths.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathOp.Xor">
|
|
<summary>Exclusive-or the two paths.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathSegmentMask">
|
|
<summary>The flags used by <see cref="P:SkiaSharp.SKPath.SegmentMasks" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathSegmentMask.Conic">
|
|
<summary>The path contains one or more conic segments.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathSegmentMask.Cubic">
|
|
<summary>The path contains one or more cubic segments.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathSegmentMask.Line">
|
|
<summary>The path contains one or more line segments.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathSegmentMask.Quad">
|
|
<summary>The path contains one or more quad segments.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPathVerb">
|
|
<summary>Verbs contained in an <see cref="T:SkiaSharp.SKPath" />.</summary>
|
|
<remarks>In the description below, the number of points returned represents the number of valid entries on the return array of points that is passed to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> or <see cref="M:SkiaSharp.SKPath.RawIterator.Next(SkiaSharp.SKPoint[])" />.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathVerb.Close">
|
|
<summary>Close path, a call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> or <see cref="M:SkiaSharp.SKPath.RawIterator.Next(SkiaSharp.SKPoint[])" /> will return one point (contour's <see cref="M:SkiaSharp.SKPath.MoveTo(SkiaSharp.SKPoint)" /> point).</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathVerb.Conic">
|
|
<summary>Conic path, a call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> or <see cref="M:SkiaSharp.SKPath.RawIterator.Next(SkiaSharp.SKPoint[])" /> will return three points, plus the <see cref="M:SkiaSharp.SKPath.RawIterator.ConicWeight" /> point.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathVerb.Cubic">
|
|
<summary>Cubic path, a call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> or <see cref="M:SkiaSharp.SKPath.RawIterator.Next(SkiaSharp.SKPoint[])" /> will return four points.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathVerb.Done">
|
|
<summary>The path is completed, points will not contain any data.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathVerb.Line">
|
|
<summary>Line path, a call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> or <see cref="M:SkiaSharp.SKPath.RawIterator.Next(SkiaSharp.SKPoint[])" /> will return two points.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathVerb.Move">
|
|
<summary>Move command, a call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> or <see cref="M:SkiaSharp.SKPath.RawIterator.Next(SkiaSharp.SKPoint[])" /> will return a single point.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPathVerb.Quad">
|
|
<summary>Quad command, a call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> or <see cref="M:SkiaSharp.SKPath.RawIterator.Next(SkiaSharp.SKPoint[])" /> will return three points.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPicture">
|
|
<summary>Recorded drawing operations made to a <see cref="T:SkiaSharp.SKCanvas" /> to be played back at a later time.</summary>
|
|
<remarks>This base class handles serialization and a few other miscellany.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPicture.CullRect">
|
|
<summary>Gets the culling rectangle for this picture.</summary>
|
|
<value />
|
|
<remarks>Operations recorded into this picture that attempt to draw outside the culling rectangle might not be drawn.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.Deserialize(SkiaSharp.SKData)">
|
|
<param name="data">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.Deserialize(SkiaSharp.SKStream)">
|
|
<param name="stream">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.Deserialize(System.IO.Stream)">
|
|
<param name="stream">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.Deserialize(System.ReadOnlySpan{System.Byte})">
|
|
<param name="data">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.Deserialize(System.IntPtr,System.Int32)">
|
|
<param name="data">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPicture" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPicture" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.Serialize">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.Serialize(SkiaSharp.SKWStream)">
|
|
<param name="stream">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.Serialize(System.IO.Stream)">
|
|
<param name="stream">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.ToShader">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.ToShader(SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode)">
|
|
<param name="tmx">To be added.</param>
|
|
<param name="tmy">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.ToShader(SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode,SkiaSharp.SKRect)">
|
|
<param name="tmx">To be added.</param>
|
|
<param name="tmy">To be added.</param>
|
|
<param name="tile">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPicture.ToShader(SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix,SkiaSharp.SKRect)">
|
|
<param name="tmx">To be added.</param>
|
|
<param name="tmy">To be added.</param>
|
|
<param name="localMatrix">To be added.</param>
|
|
<param name="tile">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPicture.UniqueId">
|
|
<summary>Gets the non-zero value unique among all pictures.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPictureRecorder">
|
|
<summary>The picture recorder is used to record drawing operations made to a <see cref="T:SkiaSharp.SKCanvas" /> and stored in a <see cref="T:SkiaSharp.SKPicture" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPictureRecorder">
|
|
<summary>Creates a new instance of the <see cref="T:SkiaSharp.SKPictureRecorder" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPictureRecorder.BeginRecording(SkiaSharp.SKRect)">
|
|
<param name="cullRect">The culling rectangle for the new picture.</param>
|
|
<summary>Start the recording process and return the recording canvas.</summary>
|
|
<returns>Returns the current recording canvas. The same can be retrieved using <see cref="P:SkiaSharp.SKPictureRecorder.RecordingCanvas" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPictureRecorder.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPictureRecorder" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPictureRecorder" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPictureRecorder.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPictureRecorder.EndRecording">
|
|
<summary>Signal that the caller is done recording.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKPicture" /> containing the recorded content.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This invalidates the canvas returned by
|
|
<xref:SkiaSharp.SKPictureRecorder.BeginRecording%2A> and
|
|
<xref:SkiaSharp.SKPictureRecorder.RecordingCanvas>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPictureRecorder.EndRecordingAsDrawable">
|
|
<summary>Signal that the caller is done recording.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKDrawable" /> containing the recorded content.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This invalidates the canvas returned by
|
|
<xref:SkiaSharp.SKPictureRecorder.BeginRecording%2A> and
|
|
<xref:SkiaSharp.SKPictureRecorder.RecordingCanvas>.
|
|
|
|
Unlike <xref:SkiaSharp.SKPictureRecorder.EndRecording%2A>, which returns an
|
|
immutable picture, the returned drawable may contain live references to other
|
|
drawables (if they were added to the recording canvas) and therefore this
|
|
drawable will reflect the current state of those nested drawables anytime it
|
|
is drawn or a new picture is snapped from it (by calling
|
|
<xref:SkiaSharp.SKDrawable.Snapshot%2A>).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPictureRecorder.RecordingCanvas">
|
|
<summary>Gets the current recording canvas.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPixelGeometry">
|
|
<summary>Describes how LCD strips are organized for each pixel.</summary>
|
|
<remarks>Description of how the LCD strips are arranged for each pixel. If this is unknown, or the pixels are meant to be "portable" and/or transformed before showing (e.g. rotated, scaled) then use <see cref="F:SkiaSharp.SKPixelGeometry.Unknown" />.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPixelGeometry.BgrHorizontal">
|
|
<summary>Pixels are made up horizontal blue, green and red lights.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPixelGeometry.BgrVertical">
|
|
<summary>Pixels are made up vertical blue, green and red lights.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPixelGeometry.RgbHorizontal">
|
|
<summary>Pixels are made up horizontal red, green and blue lights.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPixelGeometry.RgbVertical">
|
|
<summary>Pixels are made up vertical red, green and blue lights.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPixelGeometry.Unknown">
|
|
<summary>Use if the order is not known or the pixels are meant to be "portable" and/or transformed before showing (e.g. rotated, scaled).</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPixelSerializer">
|
|
<summary>Represents a mechanism for serializing pixels.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPixelSerializer">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKPixelSerializer" /> with an empty buffer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixelSerializer.Create(System.Func{SkiaSharp.SKPixmap,SkiaSharp.SKData})">
|
|
<param name="onEncode">The delegate to use to serialize the pixel data.</param>
|
|
<summary>Create a new pixel serializer using the specified delegate to encode the pixel data.</summary>
|
|
<returns>Returns an instance of the <see cref="T:SkiaSharp.SKPixelSerializer" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixelSerializer.Create(System.Func{System.IntPtr,System.IntPtr,System.Boolean},System.Func{SkiaSharp.SKPixmap,SkiaSharp.SKData})">
|
|
<param name="onUseEncodedData">The delegate to use to determine whether to use the previous encoded data, or to encode another version.</param>
|
|
<param name="onEncode">The delegate to use to serialize the pixel data.</param>
|
|
<summary>Create a new pixel serializer using the specified delegate to encode the pixel data.</summary>
|
|
<returns>Returns an instance of the <see cref="T:SkiaSharp.SKPixelSerializer" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixelSerializer.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPixelSerializer" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPixelSerializer" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixelSerializer.Encode(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixel data to encode.</param>
|
|
<summary>Encode the specified pixel data.</summary>
|
|
<returns>Returns the encoded pixel data, or <see langword="null" /> if the raw pixels should be used.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixelSerializer.OnEncode(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixel data to encode.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKPixelSerializer" /> types to encode the specified pixel data.</summary>
|
|
<returns>Returns the encoded pixel data, or <see langword="null" /> if the raw pixels should be used.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixelSerializer.OnUseEncodedData(System.IntPtr,System.IntPtr)">
|
|
<param name="data">The encoded data buffer.</param>
|
|
<param name="length">The length of the encoded data buffer.</param>
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKPixelSerializer" /> types to determine whether the caller should use the specified encoded data instead of encoding a new version.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified encoded data should be used, otherwise <see langword="false" /> to serialize another version.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If this method returns `true`, then
|
|
<xref:SkiaSharp.SKPixelSerializer.Encode%2A> should not be called to encode
|
|
the source data.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixelSerializer.UseEncodedData(System.IntPtr,System.UInt64)">
|
|
<param name="data">The encoded data buffer.</param>
|
|
<param name="length">The length of the encoded data buffer.</param>
|
|
<summary>Determines whether the serializer wants to use the specified encoded data instead of encoding a new version.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified encoded data should be used, otherwise <see langword="false" /> to serialize another version.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If this method returns `true`, then
|
|
<xref:SkiaSharp.SKPixelSerializer.Encode%2A> may not be called to encode the
|
|
source data.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPixmap">
|
|
<summary>Pairs <see cref="T:SkiaSharp.SKImageInfo" /> with actual pixels and rowbytes.</summary>
|
|
<remarks>This class does not try to manage the lifetime of the pixel memory (nor the color table if provided).</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPixmap">
|
|
<summary>Creates an empty instance of <see cref="T:SkiaSharp.SKPixmap" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPixmap(SkiaSharp.SKImageInfo,System.IntPtr)">
|
|
<param name="info">The image information of the pixels.</param>
|
|
<param name="addr">The memory address of the pixels.</param>
|
|
<summary>Creates an instance of <see cref="T:SkiaSharp.SKPixmap" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPixmap(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)">
|
|
<param name="info">The image information of the pixels.</param>
|
|
<param name="addr">The memory address of the pixels.</param>
|
|
<param name="rowBytes">The number of bytes per row.</param>
|
|
<summary>Creates an instance of <see cref="T:SkiaSharp.SKPixmap" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPixmap(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKColorTable)">
|
|
<param name="info">The image information of the pixels.</param>
|
|
<param name="addr">The memory address of the pixels.</param>
|
|
<param name="rowBytes">The number of bytes per row.</param>
|
|
<param name="ctable">The color table.</param>
|
|
<summary>Creates an instance of <see cref="T:SkiaSharp.SKPixmap" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.AlphaType">
|
|
<summary>Gets the alpha type.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.BytesPerPixel">
|
|
<summary>Gets the number of bytes per pixel.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.BytesSize">
|
|
<summary>Gets the total number of bytes needed to store the pixel data.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.ColorSpace">
|
|
<summary>Gets the color space.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.ColorTable">
|
|
<summary>Gets the color table.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.ColorType">
|
|
<summary>Gets the color type.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPixmap" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPixmap" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.DisposeManaged">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKJpegEncoderOptions)">
|
|
<param name="options">The options to use when creating the encoder.</param>
|
|
<summary>Encodes the pixmap as a JPEG.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKData" /> wrapping the encoded pixmap.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKPngEncoderOptions)">
|
|
<param name="options">The options to use when creating the encoder.</param>
|
|
<summary>Encodes the pixmap as a PNG.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKData" /> wrapping the encoded pixmap.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWebpEncoderOptions)">
|
|
<param name="options">The options to use when creating the encoder.</param>
|
|
<summary>Encodes the pixmap as a WEBP.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKData" /> wrapping the encoded pixmap.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKEncodedImageFormat,System.Int32)">
|
|
<param name="encoder">The file format used to encode the pixmap.</param>
|
|
<param name="quality">The quality level to use for the pixmap.</param>
|
|
<summary>Encodes the pixmap using the specified format.</summary>
|
|
<returns>Returns the <see cref="T:SkiaSharp.SKData" /> wrapping the encoded pixmap.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKJpegEncoderOptions)">
|
|
<param name="dst">The stream to write the encoded pixmap to.</param>
|
|
<param name="options">The options to use when creating the encoder.</param>
|
|
<summary>Encodes the pixmap as a JPEG.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKPngEncoderOptions)">
|
|
<param name="dst">The stream to write the encoded pixmap to.</param>
|
|
<param name="options">The options to use when creating the encoder.</param>
|
|
<summary>Encodes the pixmap as a PNG.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKWebpEncoderOptions)">
|
|
<param name="dst">The stream to write the encoded pixmap to.</param>
|
|
<param name="options">The options to use when creating the encoder.</param>
|
|
<summary>Encodes the pixmap as a WEBP.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(System.IO.Stream,SkiaSharp.SKJpegEncoderOptions)">
|
|
<param name="dst">To be added.</param>
|
|
<param name="options">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(System.IO.Stream,SkiaSharp.SKPngEncoderOptions)">
|
|
<param name="dst">To be added.</param>
|
|
<param name="options">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(System.IO.Stream,SkiaSharp.SKWebpEncoderOptions)">
|
|
<param name="dst">To be added.</param>
|
|
<param name="options">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKEncodedImageFormat,System.Int32)">
|
|
<param name="dst">The stream to write the encoded pixmap to.</param>
|
|
<param name="encoder">The file format used to encode the pixmap.</param>
|
|
<param name="quality">The quality level to use for the pixmap.</param>
|
|
<summary>Encodes the pixmap using the specified format.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKPixmap,SkiaSharp.SKJpegEncoderOptions)">
|
|
<param name="dst">The stream to write the encoded pixmap to.</param>
|
|
<param name="src">The pixmap to encode.</param>
|
|
<param name="options">The options to use when creating the encoder.</param>
|
|
<summary>Encodes the pixmap as a JPEG.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKPixmap,SkiaSharp.SKPngEncoderOptions)">
|
|
<param name="dst">The stream to write the encoded pixmap to.</param>
|
|
<param name="src">The pixmap to encode.</param>
|
|
<param name="options">The options to use when creating the encoder.</param>
|
|
<summary>Encodes the pixmap as a PNG.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKPixmap,SkiaSharp.SKWebpEncoderOptions)">
|
|
<param name="dst">The stream to write the encoded pixmap to.</param>
|
|
<param name="src">The pixmap to encode.</param>
|
|
<param name="options">The options to use when creating the encoder.</param>
|
|
<summary>Encodes the pixmap as a WEBP.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(System.IO.Stream,SkiaSharp.SKEncodedImageFormat,System.Int32)">
|
|
<param name="dst">To be added.</param>
|
|
<param name="encoder">To be added.</param>
|
|
<param name="quality">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKBitmap,SkiaSharp.SKEncodedImageFormat,System.Int32)">
|
|
<param name="dst">The stream to write the encoded bitmap to.</param>
|
|
<param name="src">The bitmap to encode.</param>
|
|
<param name="format">The file format used to encode the bitmap.</param>
|
|
<param name="quality">The quality level to use for the bitmap.</param>
|
|
<summary>Encodes the bitmap using the specified format.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Encode(SkiaSharp.SKWStream,SkiaSharp.SKPixmap,SkiaSharp.SKEncodedImageFormat,System.Int32)">
|
|
<param name="dst">The stream to write the encoded pixmap to.</param>
|
|
<param name="src">The pixmap to encode.</param>
|
|
<param name="encoder">The file format used to encode the pixmap.</param>
|
|
<param name="quality">The quality level to use for the pixmap.</param>
|
|
<summary>Encodes the pixmap using the specified format.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Erase(SkiaSharp.SKColor)">
|
|
<param name="color">The color to fill.</param>
|
|
<summary>Fill the entire pixmap with the specified color.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were changed, otherwise <see langword="false" />.</returns>
|
|
<remarks>If the pixmap's color type does not support alpha (e.g. 565) then the alpha of the color is ignored (treated as opaque). If the color type only supports alpha (e.g. A1 or A8) then the color's R, G, B components are ignored.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Erase(SkiaSharp.SKColorF)">
|
|
<param name="color">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Erase(SkiaSharp.SKColor,SkiaSharp.SKRectI)">
|
|
<param name="color">The color to fill.</param>
|
|
<param name="subset">The subset of the pixmap to fill.</param>
|
|
<summary>Fill the entire pixmap with the specified color.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were changed, otherwise <see langword="false" />.</returns>
|
|
<remarks>If the pixmap's color type does not support alpha (e.g. 565) then the alpha of the color is ignored (treated as opaque). If the color type only supports alpha (e.g. A1 or A8) then the color's R, G, B components are ignored.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Erase(SkiaSharp.SKColorF,SkiaSharp.SKRectI)">
|
|
<param name="color">To be added.</param>
|
|
<param name="subset">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Erase(SkiaSharp.SKColorF,SkiaSharp.SKColorSpace,SkiaSharp.SKRectI)">
|
|
<param name="color">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="subset">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.ExtractSubset(SkiaSharp.SKRectI)">
|
|
<param name="subset">The bounds of the pixmap subset to retrieve.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKPixmap" /> which is a subset of this pixmap.</summary>
|
|
<returns>Returns a subset of the pixmap.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.ExtractSubset(SkiaSharp.SKPixmap,SkiaSharp.SKRectI)">
|
|
<param name="result">The pixmap to store the subset pixels.</param>
|
|
<param name="subset">The bounds of the pixmap subset to retrieve.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKPixmap" /> which is a subset of this pixmap.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.GetPixelColor(System.Int32,System.Int32)">
|
|
<param name="x">The column index, zero or greater, and less than the pixmap width.</param>
|
|
<param name="y">The row index, zero or greater, and less than the pixmap height.</param>
|
|
<summary>Returns the color of the pixel at the specified coordinates.</summary>
|
|
<returns>Returns the color of the pixel.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.GetPixels">
|
|
<summary>Returns the memory address of the pixels.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.GetPixels(System.Int32,System.Int32)">
|
|
<param name="x">The column index, zero or greater, and less than the pixmap width.</param>
|
|
<param name="y">The row index, zero or greater, and less than the pixmap height.</param>
|
|
<summary>Returns the memory address of the pixels at (x, y).</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.GetPixelSpan">
|
|
<summary>Returns a span that wraps the pixel data.</summary>
|
|
<returns>Returns the span.</returns>
|
|
<remarks>This span is only valid as long as the pixmap is valid</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.GetPixelSpan``1">
|
|
<typeparam name="T">To be added.</typeparam>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.Height">
|
|
<summary>Gets the image height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.Info">
|
|
<summary>Gets the image info.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.ReadPixels(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixmap to read the pixel data into.</param>
|
|
<summary>Copies the pixels from the image into the specified pixmap.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.ReadPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)">
|
|
<param name="dstInfo">The image information describing the destination pixel buffer.</param>
|
|
<param name="dstPixels">The pixel buffer to read the pixel data into.</param>
|
|
<param name="dstRowBytes">The number of bytes in each row of in the destination buffer.</param>
|
|
<summary>Copies the pixels from the image into the specified buffer.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.ReadPixels(SkiaSharp.SKPixmap,System.Int32,System.Int32)">
|
|
<param name="pixmap">The pixmap to read the pixel data into.</param>
|
|
<param name="srcX">The source x-coordinate to start reading from.</param>
|
|
<param name="srcY">The source y-coordinate to start reading from.</param>
|
|
<summary>Copies the pixels from the image into the specified pixmap.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.ReadPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,System.Int32,System.Int32)">
|
|
<param name="dstInfo">The image information describing the destination pixel buffer.</param>
|
|
<param name="dstPixels">The pixel buffer to read the pixel data into.</param>
|
|
<param name="dstRowBytes">The number of bytes in each row of in the destination buffer.</param>
|
|
<param name="srcX">The source x-coordinate to start reading from.</param>
|
|
<param name="srcY">The source y-coordinate to start reading from.</param>
|
|
<summary>Copies the pixels from the image into the specified buffer.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.ReadPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,System.Int32,System.Int32,SkiaSharp.SKTransferFunctionBehavior)">
|
|
<param name="dstInfo">The image information describing the destination pixel buffer.</param>
|
|
<param name="dstPixels">The pixel buffer to read the pixel data into.</param>
|
|
<param name="dstRowBytes">The number of bytes in each row of in the destination buffer.</param>
|
|
<param name="srcX">The source x-coordinate to start reading from.</param>
|
|
<param name="srcY">The source y-coordinate to start reading from.</param>
|
|
<param name="behavior">The behavior to control whether or not the source pixels are first converted to linear space.</param>
|
|
<summary>Copies the pixels from the image into the specified buffer.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.Rect">
|
|
<summary>Gets a rectangle with the current width and height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Reset">
|
|
<summary>Reset the pixmap to an empty pixmap.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Reset(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)">
|
|
<param name="info">The image information of the pixels.</param>
|
|
<param name="addr">The memory address of the pixels.</param>
|
|
<param name="rowBytes">The number of bytes per row.</param>
|
|
<summary>Resets the pixmap to the specified pixels.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Reset(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKColorTable)">
|
|
<param name="info">The image information of the pixels.</param>
|
|
<param name="addr">The memory address of the pixels.</param>
|
|
<param name="rowBytes">The number of bytes per row.</param>
|
|
<param name="ctable">The color table.</param>
|
|
<summary>Resets the pixmap to the specified pixels.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.Resize(SkiaSharp.SKPixmap,SkiaSharp.SKPixmap,SkiaSharp.SKBitmapResizeMethod)">
|
|
<param name="dst">The pixmap to store the resized pixels.</param>
|
|
<param name="src">The pixmap to resize.</param>
|
|
<param name="method">The resize method.</param>
|
|
<summary>Resize the specified pixmap using the specified method.</summary>
|
|
<returns>Returns <see langword="true" /> if the resize operation can be performed, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.RowBytes">
|
|
<summary>Gets the number of bytes per row.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.ScalePixels(SkiaSharp.SKPixmap,SkiaSharp.SKFilterQuality)">
|
|
<param name="destination">The pixmap to recieve the scaled and converted pixels.</param>
|
|
<param name="quality">The level of quality to use when scaling the pixels.</param>
|
|
<summary>Copies this pixmap to the destination, scaling the pixels to fit the destination size and converting the pixels to match the color type and alpha type.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Pixels are copied only if pixel conversion is possible.
|
|
|
|
If the color type is <xref:SkiaSharp.SKColorType.Gray8>, or
|
|
<xref:SkiaSharp.SKColorType.Alpha8>, the destination color type must match.
|
|
If the color type is <xref:SkiaSharp.SKColorType.Gray8>, destination
|
|
colorspace must also match.
|
|
|
|
If the alpha type is <xref:SkiaSharp.SKAlphaType.Opaque>, the destination
|
|
alpha type must match.
|
|
|
|
If the colorspace is `null`, the destination colorspace must also be `null`.
|
|
|
|
Filter Quality:
|
|
|
|
- <xref:SkiaSharp.SKFilterQuality.None> is fastest, typically implemented
|
|
with nearest neighbor filter.
|
|
- <xref:SkiaSharp.SKFilterQuality.Low> is typically implemented with bilerp
|
|
filter.
|
|
- <xref:SkiaSharp.SKFilterQuality.Medium> is typically implemented with
|
|
bilerp filter, and mipmap when size is reduced.
|
|
- <xref:SkiaSharp.SKFilterQuality.High> is slowest, typically implemented
|
|
with the bicubic filter.]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.Size">
|
|
<summary>Gets the current size of the pixmap.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPixmap.Width">
|
|
<summary>Gets the image width.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.WithAlphaType(SkiaSharp.SKAlphaType)">
|
|
<param name="newAlphaType">The alpha/transparency type.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKPixmap" /> with the same properties as this <see cref="T:SkiaSharp.SKPixmap" />, but with the specified transparency type.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPixmap" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.WithColorSpace(SkiaSharp.SKColorSpace)">
|
|
<param name="newColorSpace">The color space.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKPixmap" /> with the same properties as this <see cref="T:SkiaSharp.SKPixmap" />, but with the specified color space.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPixmap" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPixmap.WithColorType(SkiaSharp.SKColorType)">
|
|
<param name="newColorType">The color type.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKPixmap" /> with the same properties as this <see cref="T:SkiaSharp.SKPixmap" />, but with the specified color type.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKPixmap" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPMColor">
|
|
<summary>32-bit ARGB premultiplied color value.</summary>
|
|
<remarks>The byte order for this value is configuration dependent. This is different from <see cref="T:SkiaSharp.SKColor" />, which is unpremultiplied, and is always in the same byte order.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPMColor(System.UInt32)">
|
|
<param name="value">The integer value of the premultiplied color.</param>
|
|
<summary>Creates a color from the specified integer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPMColor.Alpha">
|
|
<summary>Gets the alpha component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPMColor.Blue">
|
|
<summary>Gets the blue component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.Equals(SkiaSharp.SKPMColor)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>Determines whether the specified object is equal to the current object.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.Equals(System.Object)">
|
|
<param name="other">The object to compare with the current object.</param>
|
|
<summary>Determines whether the specified object is equal to the current object.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.GetHashCode">
|
|
<summary>Serves as the default hash function.</summary>
|
|
<returns>Returns a hash code for the current object.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPMColor.Green">
|
|
<summary>Gets the green component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.op_Equality(SkiaSharp.SKPMColor,SkiaSharp.SKPMColor)">
|
|
<param name="left">The first color to compare.</param>
|
|
<param name="right">The second color to compare.</param>
|
|
<summary>Indicates whether two <see cref="T:SkiaSharp.SKPMColor" /> objects are equal.</summary>
|
|
<returns>Returns <see langword="true" /> if <paramref name="left" /> is equal to <paramref name="right" />, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.op_Explicit(SkiaSharp.SKColor)~SkiaSharp.SKPMColor">
|
|
<param name="color">The unpremultiplied color to convert.</param>
|
|
<summary>Converts an unpremultiplied <see cref="T:SkiaSharp.SKColor" /> to the premultiplied <see cref="T:SkiaSharp.SKPMColor" />.</summary>
|
|
<returns>Returns the new premultiplied <see cref="T:SkiaSharp.SKPMColor" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.op_Explicit(SkiaSharp.SKPMColor)~SkiaSharp.SKColor">
|
|
<param name="color">The premultiplied color to convert.</param>
|
|
<summary>Converts a premultiplied <see cref="T:SkiaSharp.SKPMColor" /> to the unpremultiplied <see cref="T:SkiaSharp.SKColor" />.</summary>
|
|
<returns>Returns the new unpremultiplied <see cref="T:SkiaSharp.SKColor" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.op_Explicit(SkiaSharp.SKPMColor)~System.UInt32">
|
|
<param name="color">The color to convert.</param>
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKPMColor" /> to a UInt32.</summary>
|
|
<returns>The UInt32 value for the color.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.op_Implicit(System.UInt32)~SkiaSharp.SKPMColor">
|
|
<param name="color">The UInt32 representation of a color.</param>
|
|
<summary>Converts a UInt32 to a <see cref="T:SkiaSharp.SKPMColor" />.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKPMColor" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.op_Inequality(SkiaSharp.SKPMColor,SkiaSharp.SKPMColor)">
|
|
<param name="left">The first color to compare.</param>
|
|
<param name="right">The second color to compare.</param>
|
|
<summary>Indicates whether two <see cref="T:SkiaSharp.SKPMColor" /> objects are different.</summary>
|
|
<returns>Returns <see langword="true" /> if <paramref name="left" /> is not equal to <paramref name="right" />, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.PreMultiply(SkiaSharp.SKColor)">
|
|
<param name="color">The unpremultiplied color to convert.</param>
|
|
<summary>Converts an unpremultiplied <see cref="T:SkiaSharp.SKColor" /> to a premultiplied <see cref="T:SkiaSharp.SKPMColor" />.</summary>
|
|
<returns>Returns the new premultiplied <see cref="T:SkiaSharp.SKPMColor" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.PreMultiply(SkiaSharp.SKColor[])">
|
|
<param name="colors">The unpremultiplied colors to convert.</param>
|
|
<summary>Converts an array of unpremultiplied <see cref="T:SkiaSharp.SKColor" />s to an array of premultiplied <see cref="T:SkiaSharp.SKPMColor" />s.</summary>
|
|
<returns>Returns the new array of premultiplied <see cref="T:SkiaSharp.SKPMColor" />s.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPMColor.Red">
|
|
<summary>Gets the red component of the color.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.ToString">
|
|
<summary>Returns the color as a string in the format: #AARRGGBB.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.UnPreMultiply(SkiaSharp.SKPMColor)">
|
|
<param name="pmcolor">The premultiplied color to convert.</param>
|
|
<summary>Converts a premultiplied <see cref="T:SkiaSharp.SKPMColor" /> to the unpremultiplied <see cref="T:SkiaSharp.SKColor" />.</summary>
|
|
<returns>Returns the new unpremultiplied <see cref="T:SkiaSharp.SKColor" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPMColor.UnPreMultiply(SkiaSharp.SKPMColor[])">
|
|
<param name="pmcolors">The premultiplied colors to convert.</param>
|
|
<summary>Converts an array of premultiplied <see cref="T:SkiaSharp.SKPMColor" />s to an array of unpremultiplied <see cref="T:SkiaSharp.SKColor" />s.</summary>
|
|
<returns>Returns the new array of unpremultiplied <see cref="T:SkiaSharp.SKColor" />s.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPngEncoderFilterFlags">
|
|
<summary>Various row filters to use when encoding a PNG.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPngEncoderFilterFlags.AllFilters">
|
|
<summary>Try all the filters.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPngEncoderFilterFlags.Avg">
|
|
<summary>Use the average of the two neighboring pixels (left and above) to predict the value of a pixel. [Average(x) = Raw(x) - floor((Raw(x-bpp)+Prior(x))/2)]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPngEncoderFilterFlags.NoFilters">
|
|
<summary>Do not use any filters.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPngEncoderFilterFlags.None">
|
|
<summary>Transmit unmodified.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPngEncoderFilterFlags.Paeth">
|
|
<summary>Compute a simple linear function of the three neighboring pixels (left, above, upper left), then chooses as predictor the neighboring pixel closest to the computed value. [Paeth(x) = Raw(x) - PaethPredictor(Raw(x-bpp), Prior(x), Prior(x-bpp))]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPngEncoderFilterFlags.Sub">
|
|
<summary>Transmit the difference between each byte and the value of the corresponding byte of the prior pixel. [Sub(x) = Raw(x) - Raw(x-bpp)]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPngEncoderFilterFlags.Up">
|
|
<summary>Transmit the difference between each byte and the value of the corresponding byte of the pixel above. [Up(x) = Raw(x) - Prior(x)]</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPngEncoderOptions">
|
|
<summary>Options to control the PNG encoding.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPngEncoderOptions(SkiaSharp.SKPngEncoderFilterFlags,System.Int32)">
|
|
<param name="filterFlags">The filtering flags.</param>
|
|
<param name="zLibLevel">The compression level in the range 0..9.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKPngEncoderOptions" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPngEncoderOptions(SkiaSharp.SKPngEncoderFilterFlags,System.Int32,SkiaSharp.SKTransferFunctionBehavior)">
|
|
<param name="filterFlags">The filtering flags.</param>
|
|
<param name="zLibLevel">The compression level in the range 0..9.</param>
|
|
<param name="unpremulBehavior">The unpremultiplication behavior.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKPngEncoderOptions" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPngEncoderOptions.Default">
|
|
<summary>Gets a new instance of <see cref="T:SkiaSharp.SKPngEncoderOptions" /> with the values set to the defaults.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPngEncoderOptions.Equals(SkiaSharp.SKPngEncoderOptions)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPngEncoderOptions.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPngEncoderOptions.FilterFlags">
|
|
<summary>Gets or sets the filtering flags.</summary>
|
|
<value />
|
|
<remarks>
|
|
<para>If a single filter is chosen, then that filter will be used for every row.</para>
|
|
<para>If multiple filters are chosen, then a heuristic will be used to guess which filter will encode smallest, then apply that filter. This happens on a per row basis, different rows can use different filters.</para>
|
|
<para>Using a single filter (or less filters) is typically faster. Trying all of the filters may help minimize the output file size.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPngEncoderOptions.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPngEncoderOptions.op_Equality(SkiaSharp.SKPngEncoderOptions,SkiaSharp.SKPngEncoderOptions)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPngEncoderOptions.op_Inequality(SkiaSharp.SKPngEncoderOptions,SkiaSharp.SKPngEncoderOptions)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPngEncoderOptions.UnpremulBehavior">
|
|
<summary>Gets or sets the unpremultiplication behavior if the input is premultiplied.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPngEncoderOptions.ZLibLevel">
|
|
<summary>Gets or sets the compression level in the range 0..9.</summary>
|
|
<value />
|
|
<remarks>A value of 0 is a special case to skip compression entirely, creating dramatically larger PNGs.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPoint">
|
|
<summary>Represents an ordered pair of floating-point x- and y-coordinates that defines a point in a two-dimensional plane.</summary>
|
|
<remarks>To convert a <see cref="T:SkiaSharp.SKPoint" /> to a <see cref="T:SkiaSharp.SKPointI" />, use <see cref="M:SkiaSharp.SKPointI.Round(SkiaSharp.SKPoint)" /> or <see cref="M:SkiaSharp.SKPointI.Truncate(SkiaSharp.SKPoint)" />.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPoint(System.Single,System.Single)">
|
|
<param name="x">The horizontal position of the point.</param>
|
|
<param name="y">The vertical position of the point.</param>
|
|
<summary>Creates a new instance of a point with the specified coordinates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Add(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset value.</param>
|
|
<summary>Translates a given point by a specified offset.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Add(SkiaSharp.SKPoint,SkiaSharp.SKPointI)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset value.</param>
|
|
<summary>Translates a given point by a specified offset.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Add(SkiaSharp.SKPoint,SkiaSharp.SKSize)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset size.</param>
|
|
<summary>Translates a given point by a specified size.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Add(SkiaSharp.SKPoint,SkiaSharp.SKSizeI)">
|
|
<param name="pt">The point to translate</param>
|
|
<param name="sz">The offset size.</param>
|
|
<summary>Translates a given point by a specified size.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Distance(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="point">The first point.</param>
|
|
<param name="other">The second point.</param>
|
|
<summary>Calculate the Euclidean distance between two points.</summary>
|
|
<returns>Returns the Euclidean distance between two points.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.DistanceSquared(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="point">The first point.</param>
|
|
<param name="other">The second point.</param>
|
|
<summary>Calculate the Euclidean distance squared between two points.</summary>
|
|
<returns>Returns the Euclidean distance squared between two points.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPoint.Empty">
|
|
<summary>Represents a new instance of the <see cref="T:SkiaSharp.SKPoint" /> class with member data left uninitialized.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Equals(SkiaSharp.SKPoint)">
|
|
<param name="obj">The <see cref="T:SkiaSharp.SKPoint" /> to test.</param>
|
|
<summary>Specifies whether this <see cref="T:SkiaSharp.SKPoint" /> contains the same coordinates as the specified <see cref="T:SkiaSharp.SKPoint" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> has the same coordinates as this <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Equals(System.Object)">
|
|
<param name="obj">The <see cref="T:System.Object" /> to test.</param>
|
|
<summary>Specifies whether this <see cref="T:SkiaSharp.SKPoint" /> contains the same coordinates as the specified <see cref="T:System.Object" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> is a <see cref="T:SkiaSharp.SKPoint" /> and has the same coordinates as this <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.GetHashCode">
|
|
<summary>Calculates the hashcode for this point.</summary>
|
|
<returns>Returns the hashcode for this point.</returns>
|
|
<remarks>You should avoid depending on GetHashCode for unique values, as two <see cref="T:System.Drawing.Point" /> objects with the same values for their X and Y properties may return the same hash code. This behavior could change in a future release.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPoint.IsEmpty">
|
|
<summary>Gets a value indicating whether this point is empty.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPoint.Length">
|
|
<summary>Gets the Euclidean distance from the origin (0, 0).</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPoint.LengthSquared">
|
|
<summary>Gets the Euclidean distance squared from the origin (0, 0).</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Normalize(SkiaSharp.SKPoint)">
|
|
<param name="point">The point to normalize.</param>
|
|
<summary>Returns a point with the same direction as the specified point, but with a length of one.</summary>
|
|
<returns>Returns a point with a length of one.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Offset(SkiaSharp.SKPoint)">
|
|
<param name="p">The offset value.</param>
|
|
<summary>Translates a given point by a specified offset.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Offset(System.Single,System.Single)">
|
|
<param name="dx">The offset in the x-direction.</param>
|
|
<param name="dy">The offset in the y-direction.</param>
|
|
<summary>Translates a given point by a specified offset.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Addition(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset value.</param>
|
|
<summary>Translates a given point by a specified offset.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Addition(SkiaSharp.SKPoint,SkiaSharp.SKPointI)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset value.</param>
|
|
<summary>Translates a given point by a specified offset.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Addition(SkiaSharp.SKPoint,SkiaSharp.SKSize)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset size.</param>
|
|
<summary>Translates a given point by a specified size.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Addition(SkiaSharp.SKPoint,SkiaSharp.SKSizeI)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset size.</param>
|
|
<summary>Translates a given point by a specified size.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Equality(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="left">A <see cref="T:SkiaSharp.SKPoint" /> to compare.</param>
|
|
<param name="right">A <see cref="T:SkiaSharp.SKPoint" /> to compare.</param>
|
|
<summary>Compares two <see cref="T:SkiaSharp.SKPoint" /> structures. The result specifies whether the values of the <see cref="P:SkiaSharp.SKPoint.X" /> and <see cref="P:SkiaSharp.SKPoint.Y" /> properties of the two <see cref="T:SkiaSharp.SKPoint" /> structures are equal.</summary>
|
|
<returns>true if the <see cref="P:SkiaSharp.SKPoint.X" /> and <see cref="P:SkiaSharp.SKPoint.Y" /> values of the left and right <see cref="T:SkiaSharp.SKPoint" /> structures are equal; otherwise, false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Inequality(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="left">A <see cref="T:SkiaSharp.SKPoint" /> to compare.</param>
|
|
<param name="right">A <see cref="T:SkiaSharp.SKPoint" /> to compare.</param>
|
|
<summary>Determines whether the coordinates of the specified points are not equal.</summary>
|
|
<returns>true if the <see cref="P:SkiaSharp.SKPoint.X" /> and <see cref="P:SkiaSharp.SKPoint.Y" /> values of the left and right <see cref="T:SkiaSharp.SKPoint" /> structures differ; otherwise, false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Subtraction(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPoint" /> to translate.</param>
|
|
<param name="sz">The point that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a given point by the negative of a specified offset.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Subtraction(SkiaSharp.SKPoint,SkiaSharp.SKPointI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPoint" /> to translate.</param>
|
|
<param name="sz">The point that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a given point by the negative of a specified offset.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Subtraction(SkiaSharp.SKPoint,SkiaSharp.SKSize)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPoint" /> to translate.</param>
|
|
<param name="sz">The <see cref="T:SkiaSharp.SKSize" /> that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a <see cref="T:SkiaSharp.SKPoint" /> by the negative of a given <see cref="T:SkiaSharp.SKSize" />.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.op_Subtraction(SkiaSharp.SKPoint,SkiaSharp.SKSizeI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPoint" /> to translate.</param>
|
|
<param name="sz">The <see cref="T:SkiaSharp.SKSizeI" /> that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a <see cref="T:SkiaSharp.SKPoint" /> by the negative of a given <see cref="T:SkiaSharp.SKSizeI" />.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Reflect(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="point">The point to reflect.</param>
|
|
<param name="normal">The normal.</param>
|
|
<summary>Returns the reflection of a point off a surface that has the specified normal.</summary>
|
|
<returns>Returns the reflection of a point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Subtract(SkiaSharp.SKPoint,SkiaSharp.SKPoint)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPoint" /> to translate.</param>
|
|
<param name="sz">The offset that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a given point by the negative of a specified offset.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Subtract(SkiaSharp.SKPoint,SkiaSharp.SKPointI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPoint" /> to translate.</param>
|
|
<param name="sz">The offset that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a given point by the negative of a specified offset.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Subtract(SkiaSharp.SKPoint,SkiaSharp.SKSize)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPoint" /> to translate.</param>
|
|
<param name="sz">The <see cref="T:SkiaSharp.SKSize" /> that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a <see cref="T:SkiaSharp.SKPoint" /> by the negative of a specified size.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.Subtract(SkiaSharp.SKPoint,SkiaSharp.SKSizeI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPoint" /> to translate.</param>
|
|
<param name="sz">The <see cref="T:SkiaSharp.SKSize" /> that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a <see cref="T:SkiaSharp.SKPoint" /> by the negative of a specified size.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint.ToString">
|
|
<summary>Converts this <see cref="T:SkiaSharp.SKPoint" /> to a human readable string.</summary>
|
|
<returns>A string that represents this <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPoint.X">
|
|
<summary>Gets or sets the x-coordinate of this <see cref="T:SkiaSharp.SKPoint" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPoint.Y">
|
|
<summary>Gets or sets the x-coordinate of this <see cref="T:SkiaSharp.SKPoint" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPoint3">
|
|
<summary>Represents an ordered pair of floating-point x-, y- and z-coordinates that defines a point in a three-dimensional plane.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPoint3(System.Single,System.Single,System.Single)">
|
|
<param name="x">The x-coordinate of the point.</param>
|
|
<param name="y">The y-coordinate of the point.</param>
|
|
<param name="z">The z-coordinate of the point.</param>
|
|
<summary>Creates a new instance of a 3D point with the specified coordinates.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.Add(SkiaSharp.SKPoint3,SkiaSharp.SKPoint3)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset value.</param>
|
|
<summary>Translates a given point by a specified offset.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPoint3.Empty">
|
|
<summary>Represents a new instance of the <see cref="T:SkiaSharp.SKPoint3" /> class with member data left uninitialized.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.Equals(SkiaSharp.SKPoint3)">
|
|
<param name="obj">The <see cref="T:SkiaSharp.SKPoint3" /> to test.</param>
|
|
<summary>Specifies whether this <see cref="T:SkiaSharp.SKPoint3" /> contains the same coordinates as the specified <see cref="T:SkiaSharp.SKPoint3" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> has the same coordinates as this <see cref="T:SkiaSharp.SKPoint3" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.Equals(System.Object)">
|
|
<param name="obj">The <see cref="T:System.Object" /> to test.</param>
|
|
<summary>Specifies whether this <see cref="T:SkiaSharp.SKPoint3" /> contains the same coordinates as the specified <see cref="T:System.Object" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> is a <see cref="T:SkiaSharp.SKPoint3" /> and has the same coordinates as this <see cref="T:SkiaSharp.SKPoint3" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.GetHashCode">
|
|
<summary>Calculates the hashcode for this point.</summary>
|
|
<returns>Returns the hashcode for this point.</returns>
|
|
<remarks>You should avoid depending on GetHashCode for unique values, as two <see cref="T:System.Drawing.Point" /> objects with the same values for their X, Y and Z properties may return the same hash code. This behavior could change in a future release.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPoint3.IsEmpty">
|
|
<summary>Gets a value indicating whether this <see cref="T:SkiaSharp.SKPoint3" /> is empty.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.op_Addition(SkiaSharp.SKPoint3,SkiaSharp.SKPoint3)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset value.</param>
|
|
<summary>Translates a given point by a specified offset.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.op_Equality(SkiaSharp.SKPoint3,SkiaSharp.SKPoint3)">
|
|
<param name="left">A <see cref="T:SkiaSharp.SKPoint3" /> to compare.</param>
|
|
<param name="right">A <see cref="T:SkiaSharp.SKPoint3" /> to compare.</param>
|
|
<summary>Compares two <see cref="T:SkiaSharp.SKPoint3" /> structures. The result specifies whether the values of the <see cref="P:SkiaSharp.SKPoint3.X" /> and <see cref="P:SkiaSharp.SKPoint3.Y" /> properties of the two <see cref="T:SkiaSharp.SKPoint3" /> structures are equal.</summary>
|
|
<returns>true if the <see cref="P:SkiaSharp.SKPoint3.X" />, <see cref="P:SkiaSharp.SKPoint3.Y" /> and <see cref="P:SkiaSharp.SKPoint3.Z" /> values of the left and right <see cref="T:SkiaSharp.SKPoint" /> structures are equal; otherwise, false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.op_Inequality(SkiaSharp.SKPoint3,SkiaSharp.SKPoint3)">
|
|
<param name="left">A <see cref="T:SkiaSharp.SKPoint3" /> to compare.</param>
|
|
<param name="right">A <see cref="T:SkiaSharp.SKPoint3" /> to compare.</param>
|
|
<summary>Determines whether the coordinates of the specified points are not equal.</summary>
|
|
<returns>true if the <see cref="P:SkiaSharp.SKPoint3.X" />, <see cref="P:SkiaSharp.SKPoint3.Y" /> and <see cref="P:SkiaSharp.SKPoint3.Z" /> values of the left and right <see cref="T:SkiaSharp.SKPoint" /> structures differ; otherwise, false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.op_Subtraction(SkiaSharp.SKPoint3,SkiaSharp.SKPoint3)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset value.</param>
|
|
<summary>Translates a given point by the negative of a specified offset.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.Subtract(SkiaSharp.SKPoint3,SkiaSharp.SKPoint3)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The offset value.</param>
|
|
<summary>Translates a given point by the negative of a specified offset.</summary>
|
|
<returns>Returns the translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPoint3.ToString">
|
|
<summary>Converts this <see cref="T:SkiaSharp.SKPoint3" /> to a human readable string.</summary>
|
|
<returns>A string that represents this <see cref="T:SkiaSharp.SKPoint3" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPoint3.X">
|
|
<summary>Gets or sets the x-coordinate of this <see cref="T:SkiaSharp.SKPoint3" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPoint3.Y">
|
|
<summary>Gets or sets the y-coordinate of this <see cref="T:SkiaSharp.SKPoint3" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPoint3.Z">
|
|
<summary>Gets or sets the z-coordinate of this <see cref="T:SkiaSharp.SKPoint3" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPointI">
|
|
<summary>Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPointI(SkiaSharp.SKSizeI)">
|
|
<param name="sz">A <see cref="T:SkiaSharp.SKSizeI" /> that specifies the coordinates for the new <see cref="T:SkiaSharp.SKPointI" />.</param>
|
|
<summary>Initializes a new instance of the <see cref="T:SkiaSharp.SKPointI" /> class from a <see cref="T:SkiaSharp.SKSizeI" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKPointI(System.Int32,System.Int32)">
|
|
<param name="x">The horizontal position of the point.</param>
|
|
<param name="y">The vertical position of the point.</param>
|
|
<summary>Initializes a point from two floating point values.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Add(SkiaSharp.SKPointI,SkiaSharp.SKPointI)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The point that specifies the number to add to the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a given <see cref="T:SkiaSharp.SKPointI" /> by the specified point.</summary>
|
|
<returns>The translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Add(SkiaSharp.SKPointI,SkiaSharp.SKSizeI)">
|
|
<param name="pt">The point to translate.</param>
|
|
<param name="sz">The size that specifies the number to add to the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a given <see cref="T:SkiaSharp.SKPointI" /> by the specified <see cref="T:SkiaSharp.SKSizeI" />.</summary>
|
|
<returns>The translated point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Ceiling(SkiaSharp.SKPoint)">
|
|
<param name="value">The <see cref="T:SkiaSharp.SKPoint" /> to convert.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKPoint" /> to a <see cref="T:SkiaSharp.SKPointI" /> by rounding the values of the <see cref="T:SkiaSharp.SKPoint" /> to the next higher integer values.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKPointI" /> this method converts to.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Distance(SkiaSharp.SKPointI,SkiaSharp.SKPointI)">
|
|
<param name="point">The first point.</param>
|
|
<param name="other">The second point.</param>
|
|
<summary>Calculate the Euclidean distance between two points.</summary>
|
|
<returns>Returns the Euclidean distance between two points.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.DistanceSquared(SkiaSharp.SKPointI,SkiaSharp.SKPointI)">
|
|
<param name="point">The first point.</param>
|
|
<param name="other">The second point.</param>
|
|
<summary>Calculate the Euclidean distance squared between two points.</summary>
|
|
<returns>Returns the Euclidean distance squared between two points.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPointI.Empty">
|
|
<summary>Represents a new instance of the <see cref="T:SkiaSharp.SKPointI" /> class with member data left uninitialized.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Equals(SkiaSharp.SKPointI)">
|
|
<param name="obj">The <see cref="T:SkiaSharp.SKPointI" /> to test.</param>
|
|
<summary>Specifies whether this <see cref="T:SkiaSharp.SKPointI" /> contains the same coordinates as the specified <see cref="T:SkiaSharp.SKPointI" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> has the same coordinates as this <see cref="T:SkiaSharp.SKPointI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Equals(System.Object)">
|
|
<param name="obj">The <see cref="T:System.Object" /> to test.</param>
|
|
<summary>Specifies whether this <see cref="T:SkiaSharp.SKPointI" /> contains the same coordinates as the specified <see cref="T:System.Object" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> is a <see cref="T:SkiaSharp.SKPointI" /> and has the same coordinates as this <see cref="T:SkiaSharp.SKPointI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.GetHashCode">
|
|
<summary>Calculates the hashcode for this point.</summary>
|
|
<returns>Returns the hashcode for this point.</returns>
|
|
<remarks>You should avoid depending on GetHashCode for unique values, as two point objects with the same values for their X and Y properties may return the same hash code. This behavior could change in a future release.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPointI.IsEmpty">
|
|
<summary>Gets a value indicating whether this <see cref="T:SkiaSharp.SKPointI" /> is empty.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPointI.Length">
|
|
<summary>Gets the Euclidean distance from the origin (0, 0).</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPointI.LengthSquared">
|
|
<summary>Gets the Euclidean distance squared from the origin (0, 0).</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Normalize(SkiaSharp.SKPointI)">
|
|
<param name="point">The point to normalize.</param>
|
|
<summary>Returns a point with the same direction as the specified point, but with a length of one.</summary>
|
|
<returns>Returns a point with a length of one.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Offset(SkiaSharp.SKPointI)">
|
|
<param name="p">The <see cref="T:SkiaSharp.SKPointI" /> used to offset this <see cref="T:SkiaSharp.SKPointI" />.</param>
|
|
<summary>Translates this <see cref="T:SkiaSharp.SKPointI" /> by the specified <see cref="T:SkiaSharp.SKPointI" />.</summary>
|
|
<remarks>This method adjusts the <see cref="P:SkiaSharp.SKPointI.X" /> and <see cref="P:SkiaSharp.SKPointI.Y" /> values of this <see cref="T:System.Drawing.Point" /> to the sum of the <see cref="P:SkiaSharp.SKPointI.X" /> and <see cref="P:SkiaSharp.SKPointI.Y" /> values of this <see cref="T:SkiaSharp.SKPointI" /> and <paramref name="p" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Offset(System.Int32,System.Int32)">
|
|
<param name="dx">The amount to offset the x-coordinate.</param>
|
|
<param name="dy">The amount to offset the y-coordinate.</param>
|
|
<summary>Translates this <see cref="T:SkiaSharp.SKPointI" /> by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.op_Addition(SkiaSharp.SKPointI,SkiaSharp.SKPointI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPointI" /> to translate.</param>
|
|
<param name="sz">A point that specifies the pair of numbers to add to the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a <see cref="T:SkiaSharp.SKPointI" /> by a given offset.</summary>
|
|
<returns>Returns the translated <see cref="T:SkiaSharp.SKPointI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.op_Addition(SkiaSharp.SKPointI,SkiaSharp.SKSizeI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPointI" /> to translate.</param>
|
|
<param name="sz">A <see cref="T:SkiaSharp.SKSizeI" /> that specifies the pair of numbers to add to the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a <see cref="T:SkiaSharp.SKPointI" /> by a given <see cref="T:SkiaSharp.SKSizeI" />.</summary>
|
|
<returns>Returns the translated <see cref="T:SkiaSharp.SKPointI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.op_Equality(SkiaSharp.SKPointI,SkiaSharp.SKPointI)">
|
|
<param name="left">A <see cref="T:SkiaSharp.SKPointI" /> to compare.</param>
|
|
<param name="right">A <see cref="T:SkiaSharp.SKPointI" /> to compare.</param>
|
|
<summary>Determines whether the coordinates of the specified points are equal.</summary>
|
|
<returns>true if the <see cref="P:SkiaSharp.SKPointI.X" /> and <see cref="P:SkiaSharp.SKPointI.Y" /> values of the left and right <see cref="T:SkiaSharp.SKPoint" /> structures are equal; otherwise, false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.op_Explicit(SkiaSharp.SKPointI)~SkiaSharp.SKSizeI">
|
|
<param name="p">The <see cref="T:SkiaSharp.SKPointI" /> to convert.</param>
|
|
<summary>Converts an <see cref="T:SkiaSharp.SKPointI" /> into an <see cref="T:SkiaSharp.SKSizeI" />.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKSizeI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.op_Implicit(SkiaSharp.SKPointI)~SkiaSharp.SKPoint">
|
|
<param name="p">The <see cref="T:SkiaSharp.SKPointI" /> to convert.</param>
|
|
<summary>Converts an <see cref="T:SkiaSharp.SKPointI" /> into an <see cref="T:SkiaSharp.SKPoint" />.</summary>
|
|
<returns>The new <see cref="T:SkiaSharp.SKPoint" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.op_Inequality(SkiaSharp.SKPointI,SkiaSharp.SKPointI)">
|
|
<param name="left">A <see cref="T:SkiaSharp.SKPointI" /> to compare.</param>
|
|
<param name="right">A <see cref="T:SkiaSharp.SKPointI" /> to compare.</param>
|
|
<summary>Determines whether the coordinates of the specified points are not equal.</summary>
|
|
<returns>true if the <see cref="P:SkiaSharp.SKPointI.X" /> and <see cref="P:SkiaSharp.SKPointI.Y" /> values of the left and right <see cref="T:SkiaSharp.SKPoint" /> structures differ; otherwise, false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.op_Subtraction(SkiaSharp.SKPointI,SkiaSharp.SKPointI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPointI" /> to translate.</param>
|
|
<param name="sz">The point that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a <see cref="T:SkiaSharp.SKPointI" /> by the negative of a given point.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPointI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.op_Subtraction(SkiaSharp.SKPointI,SkiaSharp.SKSizeI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPointI" /> to translate.</param>
|
|
<param name="sz">The <see cref="T:SkiaSharp.SKSizeI" /> that specifies the numbers to subtract from the coordinates of <paramref name="pt" />.</param>
|
|
<summary>Translates a <see cref="T:SkiaSharp.SKPointI" /> by the negative of a given <see cref="T:SkiaSharp.SKSizeI" />.</summary>
|
|
<returns>The translated <see cref="T:SkiaSharp.SKPointI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Reflect(SkiaSharp.SKPointI,SkiaSharp.SKPointI)">
|
|
<param name="point">The point to reflect.</param>
|
|
<param name="normal">The normal.</param>
|
|
<summary>Returns the reflection of a point off a surface that has the specified normal.</summary>
|
|
<returns>Returns the reflection of a point.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Round(SkiaSharp.SKPoint)">
|
|
<param name="value">The <see cref="T:SkiaSharp.SKPoint" /> to convert.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKPoint" /> to a <see cref="T:SkiaSharp.SKPointI" /> object by rounding the <see cref="T:SkiaSharp.SKPoint" /> values to the nearest integer.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKPointI" /> this method converts to.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Subtract(SkiaSharp.SKPointI,SkiaSharp.SKPointI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPointI" /> to be subtracted from.</param>
|
|
<param name="sz">The point to subtract from the <see cref="T:SkiaSharp.SKPointI" />.</param>
|
|
<summary>Returns the result of subtracting specified point from the specified <see cref="T:SkiaSharp.SKPointI" />.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKPointI" /> that is the result of the subtraction operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Subtract(SkiaSharp.SKPointI,SkiaSharp.SKSizeI)">
|
|
<param name="pt">The <see cref="T:SkiaSharp.SKPointI" /> to be subtracted from.</param>
|
|
<param name="sz">The <see cref="T:SkiaSharp.SKSizeI" /> to subtract from the <see cref="T:SkiaSharp.SKPointI" />.</param>
|
|
<summary>Returns the result of subtracting specified <see cref="T:SkiaSharp.SKSizeI" /> from the specified <see cref="T:SkiaSharp.SKPointI" />.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKPointI" /> that is the result of the subtraction operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.ToString">
|
|
<summary>Converts this <see cref="T:SkiaSharp.SKPointI" /> to a human readable string.</summary>
|
|
<returns>A string that represents this <see cref="T:SkiaSharp.SKPointI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPointI.Truncate(SkiaSharp.SKPoint)">
|
|
<param name="value">The <see cref="T:SkiaSharp.SKPoint" /> to convert.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKPoint" /> to a <see cref="T:SkiaSharp.SKPointI" /> by truncating the values of the <see cref="T:SkiaSharp.SKPoint" />.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKPoint" /> this method converts to.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPointI.X">
|
|
<summary>Gets or sets the x-coordinate of this <see cref="T:SkiaSharp.SKPointI" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKPointI.Y">
|
|
<summary>Gets or sets the y-coordinate of this <see cref="T:SkiaSharp.SKPointI" /></summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPointMode">
|
|
<summary>Possible values to interpret the incoming array of points for the <see cref="M:SkiaSharp.SKCanvas.DrawPoints(SkiaSharp.SKPointMode,SkiaSharp.SKPoint[],SkiaSharp.SKPaint)" /> method.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPointMode.Lines">
|
|
<summary>Interpret the data as coordinates for lines.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPointMode.Points">
|
|
<summary>Interpret the data as coordinates for points.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKPointMode.Polygon">
|
|
<summary>Interpret the data as coordinates for polygons.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKPositionedRunBuffer">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPositionedRunBuffer.GetPositionSpan">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKPositionedRunBuffer.SetPositions(System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRect">
|
|
<summary>Stores a set of four floating-point numbers that represent the upper-left corner and lower-right corner of a rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRect(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="left">The left coordinate.</param>
|
|
<param name="top">The top coordinate.</param>
|
|
<param name="right">The right coordinate.</param>
|
|
<param name="bottom">The bottom coordinate.</param>
|
|
<summary>Initializes a new instance of the <see cref="T:SkiaSharp.SKRect" /> class with the specified upper-left corner and lower-right corner.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.AspectFill(SkiaSharp.SKSize)">
|
|
<param name="size">The size of the existing rectangle.</param>
|
|
<summary>Calculates the smallest rectangle that will fill the current rectangle using the specified size.</summary>
|
|
<returns>Returns the smallest rectangle that will fill the current rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.AspectFit(SkiaSharp.SKSize)">
|
|
<param name="size">The size of the existing rectangle.</param>
|
|
<summary>Calculates the largest rectangle that will fit inside the current rectangle using the specified size.</summary>
|
|
<returns>Returns the largest rectangle that will fit inside the current rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.Bottom">
|
|
<summary>Gets or sets the y-coordinate of the bottom edge of this <see cref="T:SkiaSharp.SKRect" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Contains(SkiaSharp.SKPoint)">
|
|
<param name="pt">The point to test.</param>
|
|
<summary>Determines whether the specified point is inside this rectangle.</summary>
|
|
<returns>Returns true if the point is inside this rectangle, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Contains(SkiaSharp.SKRect)">
|
|
<param name="rect">The rectangle to test.</param>
|
|
<summary>Determines whether the specified rectangle is inside this rectangle.</summary>
|
|
<returns>Returns true if the rectangle is inside this rectangle, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Contains(System.Single,System.Single)">
|
|
<param name="x">The x-coordinate.</param>
|
|
<param name="y">The y-coordinate.</param>
|
|
<summary>Determines whether the specified coordinates are inside this rectangle.</summary>
|
|
<returns>Returns true if the coordinates are inside this rectangle, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Create(SkiaSharp.SKSize)">
|
|
<param name="size">The rectangle size.</param>
|
|
<summary>Creates a new rectangle with the specified size.</summary>
|
|
<returns>Returns the new rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Create(SkiaSharp.SKPoint,SkiaSharp.SKSize)">
|
|
<param name="location">The rectangle location.</param>
|
|
<param name="size">The rectangle size.</param>
|
|
<summary>Creates a new rectangle with the specified location and size.</summary>
|
|
<returns>Returns the new rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Create(System.Single,System.Single)">
|
|
<param name="width">The rectangle width.</param>
|
|
<param name="height">The rectangle height.</param>
|
|
<summary>Creates a new rectangle with the specified size.</summary>
|
|
<returns>Returns the new rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Create(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="x">The x-coordinate.</param>
|
|
<param name="y">The y-coordinate.</param>
|
|
<param name="width">The rectangle width.</param>
|
|
<param name="height">The rectangle height.</param>
|
|
<summary>Creates a new rectangle with the specified location and size.</summary>
|
|
<returns>Returns the new rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRect.Empty">
|
|
<summary>Represents a new instance of the <see cref="T:SkiaSharp.SKRect" /> class with member data left uninitialized.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Equals(SkiaSharp.SKRect)">
|
|
<param name="obj">The <see cref="T:SkiaSharp.SKRect" /> to test.</param>
|
|
<summary>Specifies whether this rectangle contains the same coordinates as the specified <see cref="T:SkiaSharp.SKRect" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> has the same coordinates as this <see cref="T:SkiaSharp.SKRect" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Equals(System.Object)">
|
|
<param name="obj">The <see cref="T:System.Object" /> to test.</param>
|
|
<summary>Specifies whether this rectangle contains the same coordinates as the specified <see cref="T:System.Object" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> is a <see cref="T:SkiaSharp.SKRect" /> and has the same coordinates as this <see cref="T:SkiaSharp.SKRect" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.GetHashCode">
|
|
<summary>Calculates the hashcode for this rectangle.</summary>
|
|
<returns>Returns the hashcode for this rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.Height">
|
|
<summary>Gets the height of the <see cref="T:SkiaSharp.SKRect" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Inflate(SkiaSharp.SKSize)">
|
|
<param name="size">The amount to inflate this <see cref="T:SkiaSharp.SKRect" />.</param>
|
|
<summary>Enlarges this <see cref="T:SkiaSharp.SKRect" /> structure by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Inflate(System.Single,System.Single)">
|
|
<param name="x">The amount to inflate this <see cref="T:SkiaSharp.SKRect" /> structure horizontally.</param>
|
|
<param name="y">The amount to inflate this <see cref="T:SkiaSharp.SKRect" /> structure vertically.</param>
|
|
<summary>Enlarges this <see cref="T:SkiaSharp.SKRect" /> structure by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Inflate(SkiaSharp.SKRect,System.Single,System.Single)">
|
|
<param name="rect">The <see cref="T:SkiaSharp.SKRect" /> to be copied. This rectangle is not modified.</param>
|
|
<param name="x">The amount to enlarge the copy of the rectangle horizontally.</param>
|
|
<param name="y">The amount to enlarge the copy of the rectangle vertically.</param>
|
|
<summary>Creates and returns an enlarged copy of the specified <see cref="T:SkiaSharp.SKRect" /> structure. The copy is enlarged by the specified amount and the original rectangle remains unmodified.</summary>
|
|
<returns>The enlarged <see cref="T:SkiaSharp.SKRect" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Intersect(SkiaSharp.SKRect)">
|
|
<param name="rect">The rectangle to intersect.</param>
|
|
<summary>Replaces this <see cref="T:SkiaSharp.SKRect" /> structure with the intersection of itself and the specified <see cref="T:SkiaSharp.SKRect" /> structure.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Intersect(SkiaSharp.SKRect,SkiaSharp.SKRect)">
|
|
<param name="a">A rectangle to intersect.</param>
|
|
<param name="b">A rectangle to intersect.</param>
|
|
<summary>Returns a <see cref="T:SkiaSharp.SKRect" /> structure that represents the intersection of two rectangles. If there is no intersection, and empty <see cref="T:SkiaSharp.SKRect" /> is returned.</summary>
|
|
<returns>A third <see cref="T:SkiaSharp.SKRect" /> structure the size of which represents the overlapped area of the two specified rectangles.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.IntersectsWith(SkiaSharp.SKRect)">
|
|
<param name="rect">The rectangle to test.</param>
|
|
<summary>Determines if this rectangle intersects with another rectangle.</summary>
|
|
<returns>This method returns true if there is any intersection.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.IntersectsWithInclusive(SkiaSharp.SKRect)">
|
|
<param name="rect">The rectangle to test.</param>
|
|
<summary>Determines if this rectangle intersects with another rectangle.</summary>
|
|
<returns>This method returns true if there is any intersection.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.IsEmpty">
|
|
<summary>Gets a value indicating whether this rectangle has a zero size and location.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.Left">
|
|
<summary>Gets or sets the x-coordinate of the left edge of this <see cref="T:SkiaSharp.SKRect" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.Location">
|
|
<summary>Gets or sets the offset of the rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.MidX">
|
|
<summary>Gets the x-coordinate of the middle of this rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.MidY">
|
|
<summary>Gets the y-coordinate of the middle of this rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Offset(SkiaSharp.SKPoint)">
|
|
<param name="pos">The amount to offset the rectangle.</param>
|
|
<summary>Translates the this rectangle by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Offset(System.Single,System.Single)">
|
|
<param name="x">The amount to offset the location horizontally.</param>
|
|
<param name="y">The amount to offset the location vertically.</param>
|
|
<summary>Translates the this rectangle by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.op_Equality(SkiaSharp.SKRect,SkiaSharp.SKRect)">
|
|
<param name="left">The <see cref="T:SkiaSharp.SKRect" /> structure that is to the left of the equality operator.</param>
|
|
<param name="right">The <see cref="T:SkiaSharp.SKRect" /> structure that is to the right of the equality operator.</param>
|
|
<summary>Tests whether two <see cref="T:SkiaSharp.SKRect" /> structures have equal coordinates.</summary>
|
|
<returns>This operator returns true if the two specified <see cref="T:SkiaSharp.SKRect" /> structures have equal <see cref="P:SkiaSharp.SKRect.Left" />, <see cref="P:SkiaSharp.SKRect.Top" />, <see cref="P:SkiaSharp.SKRect.Right" />, and <see cref="P:SkiaSharp.SKRect.Bottom" /> properties.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.op_Implicit(SkiaSharp.SKRectI)~SkiaSharp.SKRect">
|
|
<param name="r">The <see cref="T:SkiaSharp.SKRectI" /> structure to convert.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKRectI" /> structure to a <see cref="T:SkiaSharp.SKRect" /> structure.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKRect" /> structure that is converted from the specified <see cref="T:SkiaSharp.SKRectI" /> structure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.op_Inequality(SkiaSharp.SKRect,SkiaSharp.SKRect)">
|
|
<param name="left">The <see cref="T:SkiaSharp.SKRect" /> structure that is to the left of the inequality operator.</param>
|
|
<param name="right">The <see cref="T:SkiaSharp.SKRect" /> structure that is to the right of the inequality operator.</param>
|
|
<summary>Tests whether two <see cref="T:SkiaSharp.SKRect" /> structures differ in coordinates.</summary>
|
|
<returns>This operator returns true if any of the <see cref="P:SkiaSharp.SKRect.Left" />, <see cref="P:SkiaSharp.SKRect.Top" />, <see cref="P:SkiaSharp.SKRect.Right" />, or <see cref="P:SkiaSharp.SKRect.Bottom" /> properties of the two <see cref="T:SkiaSharp.SKRect" /> structures are unequal; otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.Right">
|
|
<summary>Gets or sets the x-coordinate of the right edge of this <see cref="T:SkiaSharp.SKRect" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.Size">
|
|
<summary>Gets or sets the size of the rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.Standardized">
|
|
<summary>Gets this rectangle and a new rectangle with a positive width and height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.Top">
|
|
<summary>Gets or sets the y-coordinate of the top edge of this <see cref="T:SkiaSharp.SKRect" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.ToString">
|
|
<summary>Converts this <see cref="T:SkiaSharp.SKRect" /> to a human readable string.</summary>
|
|
<returns>A string that represents this <see cref="T:SkiaSharp.SKRect" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Union(SkiaSharp.SKRect)">
|
|
<param name="rect">A rectangle to union.</param>
|
|
<summary>Replaces this <see cref="T:SkiaSharp.SKRect" /> structure with the union of itself and the specified <see cref="T:SkiaSharp.SKRect" /> structure.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRect.Union(SkiaSharp.SKRect,SkiaSharp.SKRect)">
|
|
<param name="a">A rectangle to union.</param>
|
|
<param name="b">A rectangle to union.</param>
|
|
<summary>Creates the smallest possible third rectangle that can contain both of two rectangles that form a union.</summary>
|
|
<returns>A third <see cref="T:SkiaSharp.SKRect" /> structure that contains both of the two rectangles that form the union.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRect.Width">
|
|
<summary>Gets the width of the rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRectI">
|
|
<summary>Stores a set of four integers that represent the upper-left corner and lower-right corner of a rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRectI(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<param name="left">The left coordinate.</param>
|
|
<param name="top">The top coordinate.</param>
|
|
<param name="right">The right coordinate.</param>
|
|
<param name="bottom">The bottom coordinate.</param>
|
|
<summary>Initializes a new instance of the <see cref="T:SkiaSharp.SKRectI" /> class with the specified upper-left corner and lower-right corner.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.AspectFill(SkiaSharp.SKSizeI)">
|
|
<param name="size">The size of the existing rectangle.</param>
|
|
<summary>Calculates the smallest rectangle that will fill the current rectangle using the specified size.</summary>
|
|
<returns>Returns the smallest rectangle that will fill the current rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.AspectFit(SkiaSharp.SKSizeI)">
|
|
<param name="size">The size of the existing rectangle.</param>
|
|
<summary>Calculates the largest rectangle that will fit inside the current rectangle using the specified size.</summary>
|
|
<returns>Returns the largest rectangle that will fit inside the current rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.Bottom">
|
|
<summary>Gets or sets the y-coordinate of the bottom edge of this <see cref="T:SkiaSharp.SKRectI" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Ceiling(SkiaSharp.SKRect)">
|
|
<param name="value">The <see cref="T:SkiaSharp.SKRect" /> structure to be converted.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKRect" /> structure to a <see cref="T:SkiaSharp.SKRectI" /> structure by rounding the <see cref="T:SkiaSharp.SKRect" /> values to the next higher integer values.</summary>
|
|
<returns>Returns a <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Ceiling(SkiaSharp.SKRect,System.Boolean)">
|
|
<param name="value">The <see cref="T:SkiaSharp.SKRect" /> structure to be converted.</param>
|
|
<param name="outwards">Whether or not to move in the direction of the side.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKRect" /> structure to a <see cref="T:SkiaSharp.SKRectI" /> structure by rounding the <see cref="T:SkiaSharp.SKRect" /> values to the next higher integer values.</summary>
|
|
<returns>Returns a <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Contains(SkiaSharp.SKPointI)">
|
|
<param name="pt">The point to test.</param>
|
|
<summary>Determines whether the specified point is inside this rectangle.</summary>
|
|
<returns>Returns true if the point is inside this rectangle, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Contains(SkiaSharp.SKRectI)">
|
|
<param name="rect">The rectangle to test.</param>
|
|
<summary>Determines whether the specified rectangle is inside this rectangle.</summary>
|
|
<returns>Returns true if the rectangle is inside this rectangle, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Contains(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate.</param>
|
|
<param name="y">The y-coordinate.</param>
|
|
<summary>Determines whether the specified coordinates are inside this rectangle.</summary>
|
|
<returns>Returns true if the coordinates are inside this rectangle, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Create(SkiaSharp.SKSizeI)">
|
|
<param name="size">The rectangle size.</param>
|
|
<summary>Creates a new rectangle with the specified size.</summary>
|
|
<returns>Returns the new rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Create(SkiaSharp.SKPointI,SkiaSharp.SKSizeI)">
|
|
<param name="location">The rectangle location.</param>
|
|
<param name="size">The rectangle size.</param>
|
|
<summary>Creates a new rectangle with the specified location and size.</summary>
|
|
<returns>Returns the new rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Create(System.Int32,System.Int32)">
|
|
<param name="width">The rectangle width.</param>
|
|
<param name="height">The rectangle height.</param>
|
|
<summary>Creates a new rectangle with the specified width and height.</summary>
|
|
<returns>Returns the new rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Create(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate.</param>
|
|
<param name="y">The y-coordinate.</param>
|
|
<param name="width">The rectangle width.</param>
|
|
<param name="height">The rectangle height.</param>
|
|
<summary>Creates a new rectangle with the specified location and size.</summary>
|
|
<returns>Returns the new rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRectI.Empty">
|
|
<summary>Represents a new instance of the <see cref="T:SkiaSharp.SKRectI" /> class with member data left uninitialized.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Equals(SkiaSharp.SKRectI)">
|
|
<param name="obj">The <see cref="T:SkiaSharp.SKRectI" /> to test.</param>
|
|
<summary>Specifies whether this rectangle contains the same coordinates as the specified <see cref="T:SkiaSharp.SKRectI" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> has the same coordinates as this <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Equals(System.Object)">
|
|
<param name="obj">The <see cref="T:System.Object" /> to test.</param>
|
|
<summary>Specifies whether this rectangle contains the same coordinates as the specified <see cref="T:System.Object" />.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> is a <see cref="T:SkiaSharp.SKRectI" /> and has the same coordinates as this <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Floor(SkiaSharp.SKRect)">
|
|
<param name="value">The <see cref="T:SkiaSharp.SKRect" /> structure to be converted.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKRect" /> structure to a <see cref="T:SkiaSharp.SKRectI" /> structure by rounding the <see cref="T:SkiaSharp.SKRect" /> values to the closest lower integer values.</summary>
|
|
<returns>Returns a <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Floor(SkiaSharp.SKRect,System.Boolean)">
|
|
<param name="value">The <see cref="T:SkiaSharp.SKRect" /> structure to be converted.</param>
|
|
<param name="inwards">Whether or not to move in the direction of the side.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKRect" /> structure to a <see cref="T:SkiaSharp.SKRectI" /> structure by rounding the <see cref="T:SkiaSharp.SKRect" /> values to the closest lower integer values.</summary>
|
|
<returns>Returns a <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.GetHashCode">
|
|
<summary>Calculates the hashcode for this rectangle.</summary>
|
|
<returns>Returns the hashcode for this rectangle.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.Height">
|
|
<summary>Gets the height of the <see cref="T:SkiaSharp.SKRectI" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Inflate(SkiaSharp.SKSizeI)">
|
|
<param name="size">The amount to inflate this <see cref="T:SkiaSharp.SKRectI" />.</param>
|
|
<summary>Enlarges this <see cref="T:SkiaSharp.SKRectI" /> structure by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Inflate(System.Int32,System.Int32)">
|
|
<param name="width">The amount to inflate this <see cref="T:SkiaSharp.SKRectI" /> structure horizontally.</param>
|
|
<param name="height">The amount to inflate this <see cref="T:SkiaSharp.SKRectI" /> structure vertically.</param>
|
|
<summary>Enlarges this <see cref="T:SkiaSharp.SKRectI" /> structure by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Inflate(SkiaSharp.SKRectI,System.Int32,System.Int32)">
|
|
<param name="rect">The <see cref="T:SkiaSharp.SKRectI" /> to be copied. This rectangle is not modified.</param>
|
|
<param name="x">The amount to enlarge the copy of the rectangle horizontally.</param>
|
|
<param name="y">The amount to enlarge the copy of the rectangle vertically.</param>
|
|
<summary>Creates and returns an enlarged copy of the specified <see cref="T:SkiaSharp.SKRectI" /> structure. The copy is enlarged by the specified amount and the original rectangle remains unmodified.</summary>
|
|
<returns>The enlarged <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Intersect(SkiaSharp.SKRectI)">
|
|
<param name="rect">The rectangle to intersect.</param>
|
|
<summary>Replaces this <see cref="T:SkiaSharp.SKRectI" /> structure with the intersection of itself and the specified <see cref="T:SkiaSharp.SKRectI" /> structure.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Intersect(SkiaSharp.SKRectI,SkiaSharp.SKRectI)">
|
|
<param name="a">A rectangle to intersect.</param>
|
|
<param name="b">A rectangle to intersect.</param>
|
|
<summary>Returns a <see cref="T:SkiaSharp.SKRectI" /> structure that represents the intersection of two rectangles. If there is no intersection, and empty <see cref="T:SkiaSharp.SKRectI" /> is returned.</summary>
|
|
<returns>A third <see cref="T:SkiaSharp.SKRectI" /> structure the size of which represents the overlapped area of the two specified rectangles.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.IntersectsWith(SkiaSharp.SKRectI)">
|
|
<param name="rect">The rectangle to test.</param>
|
|
<summary>Determines if this rectangle intersects with another rectangle.</summary>
|
|
<returns>This method returns true if there is any intersection.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.IntersectsWithInclusive(SkiaSharp.SKRectI)">
|
|
<param name="rect">The rectangle to test.</param>
|
|
<summary>Determines if this rectangle intersects with another rectangle.</summary>
|
|
<returns>This method returns true if there is any intersection.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.IsEmpty">
|
|
<summary>Gets a value indicating whether this rectangle has a zero size and location.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.Left">
|
|
<summary>Gets or sets the x-coordinate of the left edge of this <see cref="T:SkiaSharp.SKRectI" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.Location">
|
|
<summary>Gets or sets the offset of the rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.MidX">
|
|
<summary>Gets the x-coordinate of the middle of this rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.MidY">
|
|
<summary>Gets the y-coordinate of the middle of this rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Offset(SkiaSharp.SKPointI)">
|
|
<param name="pos">The amount to offset the rectangle.</param>
|
|
<summary>Translates the this rectangle by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Offset(System.Int32,System.Int32)">
|
|
<param name="x">The amount to offset the location horizontally.</param>
|
|
<param name="y">The amount to offset the location vertically.</param>
|
|
<summary>Translates the this rectangle by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.op_Equality(SkiaSharp.SKRectI,SkiaSharp.SKRectI)">
|
|
<param name="left">The <see cref="T:SkiaSharp.SKRectI" /> structure that is to the left of the equality operator.</param>
|
|
<param name="right">The <see cref="T:SkiaSharp.SKRectI" /> structure that is to the right of the equality operator.</param>
|
|
<summary>Tests whether two <see cref="T:SkiaSharp.SKRectI" /> structures have equal location and size.</summary>
|
|
<returns>This operator returns true if the two specified <see cref="T:SkiaSharp.SKRectI" /> structures have equal <see cref="P:SkiaSharp.SKRectI.Left" />, <see cref="P:SkiaSharp.SKRectI.Top" />, <see cref="P:SkiaSharp.SKRectI.Right" />, or <see cref="P:SkiaSharp.SKRectI.Bottom" /> properties.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.op_Inequality(SkiaSharp.SKRectI,SkiaSharp.SKRectI)">
|
|
<param name="left">The <see cref="T:SkiaSharp.SKRectI" /> structure that is to the left of the inequality operator.</param>
|
|
<param name="right">The <see cref="T:SkiaSharp.SKRectI" /> structure that is to the right of the inequality operator.</param>
|
|
<summary>Tests whether two <see cref="T:SkiaSharp.SKRectI" /> structures differ in location or size.</summary>
|
|
<returns>This operator returns true if any of the <see cref="P:SkiaSharp.SKRectI.Left" />, <see cref="P:SkiaSharp.SKRectI.Top" />, <see cref="P:SkiaSharp.SKRectI.Right" />, or <see cref="P:SkiaSharp.SKRectI.Bottom" /> properties of the two <see cref="T:SkiaSharp.SKRectI" /> structures are unequal; otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.Right">
|
|
<summary>Gets or sets the x-coordinate of the right edge of this <see cref="T:SkiaSharp.SKRectI" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Round(SkiaSharp.SKRect)">
|
|
<param name="value">The <see cref="T:SkiaSharp.SKRect" /> structure to be converted.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKRect" /> structure to a <see cref="T:SkiaSharp.SKRectI" /> structure by rounding the <see cref="T:SkiaSharp.SKRect" /> values to the nearest integer values.</summary>
|
|
<returns>Returns a <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.Size">
|
|
<summary>Gets or sets the size of the <see cref="T:SkiaSharp.SKRectI" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.Standardized">
|
|
<summary>Gets this rectangle and a new rectangle with a positive width and height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.Top">
|
|
<summary>Gets or sets the y-coordinate of the top edge of this <see cref="T:SkiaSharp.SKRectI" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.ToString">
|
|
<summary>Converts this <see cref="T:SkiaSharp.SKRectI" /> to a human readable string.</summary>
|
|
<returns>A string that represents this <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Truncate(SkiaSharp.SKRect)">
|
|
<param name="value">The <see cref="T:SkiaSharp.SKRect" /> to be converted.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKRect" /> structure to a <see cref="T:SkiaSharp.SKRectI" /> structure by truncating the <see cref="T:SkiaSharp.SKRect" /> values.</summary>
|
|
<returns>The truncated value of the <see cref="T:SkiaSharp.SKRectI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Union(SkiaSharp.SKRectI)">
|
|
<param name="rect">A rectangle to union.</param>
|
|
<summary>Replaces this <see cref="T:SkiaSharp.SKRectI" /> structure with the union of itself and the specified <see cref="T:SkiaSharp.SKRectI" /> structure.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRectI.Union(SkiaSharp.SKRectI,SkiaSharp.SKRectI)">
|
|
<param name="a">A rectangle to union.</param>
|
|
<param name="b">A rectangle to union.</param>
|
|
<summary>Creates the smallest possible third rectangle that can contain both of two rectangles that form a union.</summary>
|
|
<returns>A third <see cref="T:SkiaSharp.SKRectI" /> structure that contains both of the two rectangles that form the union.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRectI.Width">
|
|
<summary>Gets the width of the <see cref="T:SkiaSharp.SKRectI" />.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRegion">
|
|
<summary>Encapsulates the geometric region used to specify clipping areas for drawing.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRegion">
|
|
<summary>Creates an empty region.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRegion(SkiaSharp.SKPath)">
|
|
<param name="path">The path to use as the region.</param>
|
|
<summary>Creates a new region using the area described by the path.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRegion(SkiaSharp.SKRectI)">
|
|
<param name="rect">The rectangle to use as the region.</param>
|
|
<summary>Creates a new region using the area described by the rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRegion(SkiaSharp.SKRegion)">
|
|
<param name="region">The region to copy.</param>
|
|
<summary>Creates a new region by copying an existing region.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRegion.Bounds">
|
|
<summary>Gets the bounds of this region.</summary>
|
|
<value />
|
|
<remarks>If the region is empty, returns an empty rectangle.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Contains(SkiaSharp.SKPath)">
|
|
<param name="path">The path to check with.</param>
|
|
<summary>Check to see if the specified path is completely inside the current region.</summary>
|
|
<returns>Returns true if the specified path is completely inside the current region, otherwise false.</returns>
|
|
<remarks>This works for simple (rectangular) and complex path, and always returns the correct result. If either the path or the region is empty, this method returns false.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Contains(SkiaSharp.SKPointI)">
|
|
<param name="xy">The coordinates to check with.</param>
|
|
<summary>Check to see if the specified coordinates are completely inside the current region.</summary>
|
|
<returns>Returns true if the specified coordinates are completely inside the current region, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Contains(SkiaSharp.SKRectI)">
|
|
<param name="rect">The rect to check with.</param>
|
|
<summary>Check to see if the specified rect is completely inside the current region.</summary>
|
|
<returns>Returns true if the specified rect is completely inside the current region, otherwise false.</returns>
|
|
<remarks>If either the rect or the region is empty, this method returns false.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Contains(SkiaSharp.SKRegion)">
|
|
<param name="src">The region to check with.</param>
|
|
<summary>Check to see if the specified region is completely inside the current region.</summary>
|
|
<returns>Returns true if the specified region is completely inside the current region, otherwise false.</returns>
|
|
<remarks>This works for simple (rectangular) and complex regions, and always returns the correct result. If either region is empty, this method returns false.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Contains(System.Int32,System.Int32)">
|
|
<param name="x">The x-coordinate to check with.</param>
|
|
<param name="y">The y-coordinate to check with.</param>
|
|
<summary>Check to see if the specified coordinates are completely inside the current region.</summary>
|
|
<returns>Returns true if the specified coordinates are completely inside the current region, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.CreateClipIterator(SkiaSharp.SKRectI)">
|
|
<param name="clip">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.CreateRectIterator">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.CreateSpanIterator(System.Int32,System.Int32,System.Int32)">
|
|
<param name="y">To be added.</param>
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKRegion" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKRegion" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.GetBoundaryPath">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Intersects(SkiaSharp.SKPath)">
|
|
<param name="path">The path to check with.</param>
|
|
<summary>Check to see if the specified path intersects with the current region.</summary>
|
|
<returns>Returns true if the specified path has a non-empty intersection with the current region.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Intersects(SkiaSharp.SKRectI)">
|
|
<param name="rect">The rectangle to check with.</param>
|
|
<summary>Check to see if the specified rectangle intersects with the current region.</summary>
|
|
<returns>Returns true if the specified rectangle has a non-empty intersection with the current region.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Intersects(SkiaSharp.SKRegion)">
|
|
<param name="region">The region to check with.</param>
|
|
<summary>Check to see if the specified region intersects with the current region.</summary>
|
|
<returns>Returns true if the specified region has a non-empty intersection with the current region.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRegion.IsComplex">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRegion.IsEmpty">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRegion.IsRect">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Op(SkiaSharp.SKPath,SkiaSharp.SKRegionOperation)">
|
|
<param name="path">The path to apply the operator on.</param>
|
|
<param name="op">The operator to apply.</param>
|
|
<summary>Set this region to the result of applying the operation to this region and the specified path.</summary>
|
|
<returns>Returns true if the resulting region is non-empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Op(SkiaSharp.SKRectI,SkiaSharp.SKRegionOperation)">
|
|
<param name="rect">The rectangle to apply the operator on.</param>
|
|
<param name="op">The operator to apply.</param>
|
|
<summary>Set this region to the result of applying the operation to this region and the specified rectangle.</summary>
|
|
<returns>Returns true if the resulting region is non-empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Op(SkiaSharp.SKRegion,SkiaSharp.SKRegionOperation)">
|
|
<param name="region">The region to apply the operator on.</param>
|
|
<param name="op">The operator to apply.</param>
|
|
<summary>Set this region to the result of applying the operation to this region and the specified region.</summary>
|
|
<returns>Returns true if the resulting region is non-empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Op(System.Int32,System.Int32,System.Int32,System.Int32,SkiaSharp.SKRegionOperation)">
|
|
<param name="left">The x-coordinate to apply the operator on.</param>
|
|
<param name="top">The y-coordinate to apply the operator on.</param>
|
|
<param name="right">The right-coordinate to apply the operator on.</param>
|
|
<param name="bottom">The bottom-coordinate to apply the operator on.</param>
|
|
<param name="op">The operator to apply.</param>
|
|
<summary>Set this region to the result of applying the operation to this region and the specified rectangle.</summary>
|
|
<returns>Returns true if the resulting region is non-empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.QuickContains(SkiaSharp.SKRectI)">
|
|
<param name="rect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.QuickReject(SkiaSharp.SKPath)">
|
|
<param name="path">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.QuickReject(SkiaSharp.SKRectI)">
|
|
<param name="rect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.QuickReject(SkiaSharp.SKRegion)">
|
|
<param name="region">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.SetEmpty">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.SetPath(SkiaSharp.SKPath)">
|
|
<param name="path">The replacement path.</param>
|
|
<summary>Set this region to the area described by the path, clipped to the current region.</summary>
|
|
<returns>Returns true if the resulting region is non-empty.</returns>
|
|
<remarks>This produces a region that is identical to the pixels that would be drawn by the path (with no anti-aliasing) with the current region as the clip.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.SetPath(SkiaSharp.SKPath,SkiaSharp.SKRegion)">
|
|
<param name="path">The replacement path.</param>
|
|
<param name="clip">The clipping region.</param>
|
|
<summary>Set this region to the area described by the path, clipped.</summary>
|
|
<returns>Returns true if the resulting region is non-empty.</returns>
|
|
<remarks>This produces a region that is identical to the pixels that would be drawn by the path (with no anti-aliasing) with the specified clip.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.SetRect(SkiaSharp.SKRectI)">
|
|
<param name="rect">The replacement rectangle.</param>
|
|
<summary>Set this region to the specified rectangle.</summary>
|
|
<returns>Returns true if the resulting region is non-empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.SetRects(SkiaSharp.SKRectI[])">
|
|
<param name="rects">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.SetRegion(SkiaSharp.SKRegion)">
|
|
<param name="region">The replacement region.</param>
|
|
<summary>Set this region to the specified region.</summary>
|
|
<returns>Return true if the resulting region is non-empty.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion.Translate(System.Int32,System.Int32)">
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRegion+ClipIterator">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion+ClipIterator.DisposeNative">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion+ClipIterator.Next(SkiaSharp.SKRectI@)">
|
|
<param name="rect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRegion+RectIterator">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion+RectIterator.DisposeNative">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion+RectIterator.Next(SkiaSharp.SKRectI@)">
|
|
<param name="rect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRegion+SpanIterator">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion+SpanIterator.DisposeNative">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRegion+SpanIterator.Next(System.Int32@,System.Int32@)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRegionOperation">
|
|
<summary>The logical operations that can be performed when combining two regions.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRegionOperation.Difference">
|
|
<summary>Subtract the op region from the first region.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRegionOperation.Intersect">
|
|
<summary>Intersect the two regions.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRegionOperation.Replace">
|
|
<summary>Replace the destination region with the op region.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRegionOperation.ReverseDifference">
|
|
<summary>Subtract the first region from the op region.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRegionOperation.Union">
|
|
<summary>Union (inclusive-or) the two regions.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRegionOperation.XOR">
|
|
<summary>Exclusive-or the two regions.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRotationScaleMatrix">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRotationScaleMatrix(System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="scos">To be added.</param>
|
|
<param name="ssin">To be added.</param>
|
|
<param name="tx">To be added.</param>
|
|
<param name="ty">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.Create(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="scale">To be added.</param>
|
|
<param name="radians">To be added.</param>
|
|
<param name="tx">To be added.</param>
|
|
<param name="ty">To be added.</param>
|
|
<param name="anchorX">To be added.</param>
|
|
<param name="anchorY">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.CreateDegrees(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="scale">To be added.</param>
|
|
<param name="degrees">To be added.</param>
|
|
<param name="tx">To be added.</param>
|
|
<param name="ty">To be added.</param>
|
|
<param name="anchorX">To be added.</param>
|
|
<param name="anchorY">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.CreateIdentity">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.CreateRotation(System.Single,System.Single,System.Single)">
|
|
<param name="radians">To be added.</param>
|
|
<param name="anchorX">To be added.</param>
|
|
<param name="anchorY">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.CreateRotationDegrees(System.Single,System.Single,System.Single)">
|
|
<param name="degrees">To be added.</param>
|
|
<param name="anchorX">To be added.</param>
|
|
<param name="anchorY">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.CreateScale(System.Single)">
|
|
<param name="s">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.CreateTranslation(System.Single,System.Single)">
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRotationScaleMatrix.Empty">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.Equals(SkiaSharp.SKRotationScaleMatrix)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRotationScaleMatrix.Identity">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.op_Equality(SkiaSharp.SKRotationScaleMatrix,SkiaSharp.SKRotationScaleMatrix)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.op_Inequality(SkiaSharp.SKRotationScaleMatrix,SkiaSharp.SKRotationScaleMatrix)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRotationScaleMatrix.SCos">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRotationScaleMatrix.SSin">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleMatrix.ToMatrix">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRotationScaleMatrix.TX">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRotationScaleMatrix.TY">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRotationScaleRunBuffer">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleRunBuffer.GetRotationScaleSpan">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRotationScaleRunBuffer.SetRotationScale(System.ReadOnlySpan{SkiaSharp.SKRotationScaleMatrix})">
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRoundRect">
|
|
<summary>Represents a rounded rectangle with a potentially different radii for each corner.</summary>
|
|
<remarks>If either of a corner's radii are 0 the corner will be square and negative radii are not allowed (they are clamped to zero).</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRoundRect">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKRoundRect" /> with all values initialized to 0.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRoundRect(SkiaSharp.SKRect)">
|
|
<param name="rect">The bounds of the new rectangle.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKRoundRect" /> with all radii set to 0.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRoundRect(SkiaSharp.SKRoundRect)">
|
|
<param name="rrect">The rounded rectangle to copy.</param>
|
|
<summary>Creates a copy of a <see cref="T:SkiaSharp.SKRoundRect" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRoundRect(SkiaSharp.SKRect,System.Single)">
|
|
<param name="rect">The bounds of the new rectangle.</param>
|
|
<param name="radius">The radii of the corners.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKRoundRect" /> with the same radii for all four corners.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRoundRect(SkiaSharp.SKRect,System.Single,System.Single)">
|
|
<param name="rect">The bounds of the new rectangle.</param>
|
|
<param name="xRadius">The radii of the corners along the x-axis.</param>
|
|
<param name="yRadius">The radii of the corners along the y-axis.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKRoundRect" /> with the same radii for all four corners.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRoundRect.AllCornersCircular">
|
|
<summary>Gets a value indicating whether all four corners are circular (with the x- and y-axis equal).</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.CheckAllCornersCircular(System.Single)">
|
|
<param name="tolerance">The difference in the axis allowed before the corners are no longer circular.</param>
|
|
<summary>Check to see whether all four corners are circular (with the x- and y-axis equal).</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.Contains(SkiaSharp.SKRect)">
|
|
<param name="rect">The rectangle.</param>
|
|
<summary>Determines whether the specified rectangle is wholly contained within the rounded rectangle.</summary>
|
|
<returns>Returns <see langword="true" /> if the specified rectangle is inside the rounded rectangle, otherwise <see langword="false" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.Deflate(SkiaSharp.SKSize)">
|
|
<param name="size">The amount to deflate the rectangle by.</param>
|
|
<summary>Deflate the rectangle by the specified amount.</summary>
|
|
<remarks>The corner radii are adjusted by the amount of the deflation if they are round.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.Deflate(System.Single,System.Single)">
|
|
<param name="dx">The amount to deflate the rectangle by along the x-axis.</param>
|
|
<param name="dy">The amount to deflate the rectangle by along the y-axis.</param>
|
|
<summary>Deflate the rectangle by the specified amount.</summary>
|
|
<remarks>The corner radii are adjusted by the amount of the deflation if they are round.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKRoundRect" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKRoundRect" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.GetRadii(SkiaSharp.SKRoundRectCorner)">
|
|
<param name="corner">The corner to retrieve.</param>
|
|
<summary>Retrieves the radii of the specified corner.</summary>
|
|
<returns>Returns the radii of the specified corner.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRoundRect.Height">
|
|
<summary>Gets the height of the rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.Inflate(SkiaSharp.SKSize)">
|
|
<param name="size">The amount to inflate the rectangle by.</param>
|
|
<summary>Inflate the rectangle by the specified amount.</summary>
|
|
<remarks>The corner radii are adjusted by the amount of the inflation if they are round.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.Inflate(System.Single,System.Single)">
|
|
<param name="dx">The amount to inflate the rectangle by along the x-axis.</param>
|
|
<param name="dy">The amount to inflate the rectangle by along the y-axis.</param>
|
|
<summary>Inflate the rectangle by the specified amount.</summary>
|
|
<remarks>The corner radii are adjusted by the amount of the inflation if they are round.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRoundRect.IsValid">
|
|
<summary>Gets a value indicating whether the rectangle has a valid bounds, radii and type.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.Offset(SkiaSharp.SKPoint)">
|
|
<param name="pos">The amount to translate the rectangle by.</param>
|
|
<summary>Translate the rectangle by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.Offset(System.Single,System.Single)">
|
|
<param name="dx">The amount to translate the rectangle by along the x-axis.</param>
|
|
<param name="dy">The amount to translate the rectangle by along the y-axis.</param>
|
|
<summary>Translate the rectangle by the specified amount.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRoundRect.Radii">
|
|
<summary>Gets the radii of the corners.</summary>
|
|
<value />
|
|
<remarks>The order of the corners are clockwise from the top left: Top Left, Top Right, Bottom Right, Bottom Left.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRoundRect.Rect">
|
|
<summary>Gets the rectangle bounds of the rounded rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.SetEmpty">
|
|
<summary>Set this rounded rectangle to an empty rectangle (with all values 0).</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.SetNinePatch(SkiaSharp.SKRect,System.Single,System.Single,System.Single,System.Single)">
|
|
<param name="rect">The interior rectangle.</param>
|
|
<param name="leftRadius">The radii along the x-axis on the left side of the rectangle.</param>
|
|
<param name="topRadius">The radii along the y-axis on the top of the rectangle.</param>
|
|
<param name="rightRadius">The radii along the x-axis on the right side of the rectangle.</param>
|
|
<param name="bottomRadius">The radii along the y-axis on the bottom of the rectangle.</param>
|
|
<summary>Set this rounded rectangle to a nine-patch rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.SetOval(SkiaSharp.SKRect)">
|
|
<param name="rect">The outer bounds of the oval.</param>
|
|
<summary>Set this rectangle to be an oval.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.SetRect(SkiaSharp.SKRect)">
|
|
<param name="rect">The simple rectangle.</param>
|
|
<summary>Set this rectangle to be a simple rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.SetRect(SkiaSharp.SKRect,System.Single,System.Single)">
|
|
<param name="rect">The simple rectangle.</param>
|
|
<param name="xRadius">The radii of the corners along the x-axis.</param>
|
|
<param name="yRadius">The radii of the corners along the y-axis.</param>
|
|
<summary>Set this rectangle to be a simple rounded rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.SetRectRadii(SkiaSharp.SKRect,SkiaSharp.SKPoint[])">
|
|
<param name="rect">The rectangle.</param>
|
|
<param name="radii">The corner radii.</param>
|
|
<summary>Set this rectangle to be a rounded rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.Transform(SkiaSharp.SKMatrix)">
|
|
<param name="matrix">The transformation matrix.</param>
|
|
<summary>Create a new rounded rectangle that is transformed by the specified matrix.</summary>
|
|
<returns>Returns a new, transformed rectangle if the matrix was valid, otherwise null.</returns>
|
|
<remarks>The transformation matrix must be a scale and/or translation matrix.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRoundRect.TryTransform(SkiaSharp.SKMatrix,SkiaSharp.SKRoundRect@)">
|
|
<param name="matrix">The transformation matrix.</param>
|
|
<param name="transformed">The transformed rounded rectangle.</param>
|
|
<summary>Create a new rounded rectangle that is transformed by the specified matrix.</summary>
|
|
<returns>Returns a <see langword="true" /> if the transformation was successful, otherwise <see langword="false" /> .</returns>
|
|
<remarks>The transformation matrix must be a scale and/or translation matrix.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRoundRect.Type">
|
|
<summary>Gets a value indicating what sub-type of rounded rectangle this instance is.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRoundRect.Width">
|
|
<summary>Gets the width of the rectangle.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRoundRectCorner">
|
|
<summary>Represents the corners of a rounded rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectCorner.LowerLeft">
|
|
<summary>The lower-left or bottom-left corner.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectCorner.LowerRight">
|
|
<summary>The lower-right or bottom-right corner.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectCorner.UpperLeft">
|
|
<summary>The upper-left or top-left corner.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectCorner.UpperRight">
|
|
<summary>The upper-right or top-right corner.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRoundRectType">
|
|
<summary>Represents the various sub-types of rounded rectangles.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectType.Complex">
|
|
<summary>A non-empty rounded rectangle with at least one corner non-zero.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectType.Empty">
|
|
<summary>An empty (all zero) rounded rectangle.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectType.NinePatch">
|
|
<summary>A non-empty rounded rectangle where the left x-radii are equal, the top y-radii are equal, the right x-radii are equal and the bottom y-radii are equal.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectType.Oval">
|
|
<summary>A non-empty rounded rectangle with the x-radii equal to half the width and the y-radii equal to half the height.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectType.Rect">
|
|
<summary>A non-empty rounded rectangle with zero radii at all corners.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKRoundRectType.Simple">
|
|
<summary>A non-empty rounded rectangle with equal x-radii and equal y-radii.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRunBuffer">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRunBuffer.GetClusterSpan">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRunBuffer.GetGlyphSpan">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRunBuffer.GetTextSpan">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRunBuffer.SetClusters(System.ReadOnlySpan{System.UInt32})">
|
|
<param name="clusters">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRunBuffer.SetGlyphs(System.ReadOnlySpan{System.UInt16})">
|
|
<param name="glyphs">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRunBuffer.SetText(System.ReadOnlySpan{System.Byte})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRunBuffer.Size">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRunBuffer.TextSize">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRuntimeEffect">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffect.Children">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffect.Create(System.String,System.String@)">
|
|
<param name="sksl">To be added.</param>
|
|
<param name="errors">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffect.ToColorFilter">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffect.ToColorFilter(SkiaSharp.SKRuntimeEffectUniforms)">
|
|
<param name="uniforms">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffect.ToColorFilter(SkiaSharp.SKRuntimeEffectUniforms,SkiaSharp.SKRuntimeEffectChildren)">
|
|
<param name="uniforms">To be added.</param>
|
|
<param name="children">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffect.ToShader(System.Boolean)">
|
|
<param name="isOpaque">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffect.ToShader(System.Boolean,SkiaSharp.SKRuntimeEffectUniforms)">
|
|
<param name="isOpaque">To be added.</param>
|
|
<param name="uniforms">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffect.ToShader(System.Boolean,SkiaSharp.SKRuntimeEffectUniforms,SkiaSharp.SKRuntimeEffectChildren)">
|
|
<param name="isOpaque">To be added.</param>
|
|
<param name="uniforms">To be added.</param>
|
|
<param name="children">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffect.ToShader(System.Boolean,SkiaSharp.SKRuntimeEffectUniforms,SkiaSharp.SKRuntimeEffectChildren,SkiaSharp.SKMatrix)">
|
|
<param name="isOpaque">To be added.</param>
|
|
<param name="uniforms">To be added.</param>
|
|
<param name="children">To be added.</param>
|
|
<param name="localMatrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffect.Uniforms">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffect.UniformSize">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRuntimeEffectChildren">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRuntimeEffectChildren(SkiaSharp.SKRuntimeEffect)">
|
|
<param name="effect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectChildren.Add(System.String,SkiaSharp.SKShader)">
|
|
<param name="name">To be added.</param>
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectChildren.Contains(System.String)">
|
|
<param name="name">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffectChildren.Count">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectChildren.GetEnumerator">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffectChildren.Item(System.String)">
|
|
<param name="name">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffectChildren.Names">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectChildren.Reset">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectChildren.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectChildren.ToArray">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRuntimeEffectUniform">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffectUniform.Empty">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffectUniform.IsEmpty">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniform.op_Implicit(SkiaSharp.SKMatrix)~SkiaSharp.SKRuntimeEffectUniform">
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniform.op_Implicit(System.ReadOnlySpan{System.Single})~SkiaSharp.SKRuntimeEffectUniform">
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniform.op_Implicit(System.Single)~SkiaSharp.SKRuntimeEffectUniform">
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniform.op_Implicit(System.Single[])~SkiaSharp.SKRuntimeEffectUniform">
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniform.op_Implicit(System.Single[][])~SkiaSharp.SKRuntimeEffectUniform">
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniform.op_Implicit(System.Span{System.Single})~SkiaSharp.SKRuntimeEffectUniform">
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffectUniform.Size">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniform.WriteTo(System.Span{System.Byte})">
|
|
<param name="data">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKRuntimeEffectUniforms">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKRuntimeEffectUniforms(SkiaSharp.SKRuntimeEffect)">
|
|
<param name="effect">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniforms.Add(System.String,SkiaSharp.SKRuntimeEffectUniform)">
|
|
<param name="name">To be added.</param>
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniforms.Contains(System.String)">
|
|
<param name="name">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffectUniforms.Count">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniforms.GetEnumerator">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffectUniforms.Item(System.String)">
|
|
<param name="name">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKRuntimeEffectUniforms.Names">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniforms.Reset">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniforms.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKRuntimeEffectUniforms.ToData">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKShader">
|
|
<summary>Shaders specify the source color(s) for what is being drawn in the <see cref="T:SkiaSharp.SKPaint" />.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
Shaders specify the source colors for what is being drawn. If a paint has no
|
|
shader, then the paint's color is used. If the paint has a shader, then the
|
|
shader's colors are used instead, but they are modulated by the paint's alpha.
|
|
|
|
This makes it easy to create a shader once (for example, bitmap tiling or
|
|
gradient) and then change its transparency without having to modify the
|
|
original shader, only the paint's alpha needs to be modified.
|
|
|
|
Shaders are created by calling one of the static "Create" methods.
|
|
|
|
## Examples
|
|
|
|
### Linear Gradient Shader Example
|
|
|
|
```csharp
|
|
var info = new SKImageInfo(256, 256);
|
|
using (var surface = SKSurface.Create(info)) {
|
|
SKCanvas canvas = surface.Canvas;
|
|
|
|
canvas.Clear(SKColors.White);
|
|
|
|
// create the shader
|
|
var colors = new SKColor[] {
|
|
new SKColor(0, 0, 255),
|
|
new SKColor(0, 255, 0)
|
|
};
|
|
var shader = SKShader.CreateLinearGradient(
|
|
new SKPoint(0, 0),
|
|
new SKPoint(255, 255),
|
|
colors,
|
|
null,
|
|
SKShaderTileMode.Clamp);
|
|
|
|
// use the shader
|
|
var paint = new SKPaint {
|
|
Shader = shader
|
|
};
|
|
canvas.DrawPaint(paint);
|
|
}
|
|
```
|
|
|
|
The example above produces the following:
|
|
|
|

|
|
|
|
### Radial Gradient Shader Example
|
|
|
|
```csharp
|
|
var info = new SKImageInfo(256, 256);
|
|
using (var surface = SKSurface.Create(info)) {
|
|
SKCanvas canvas = surface.Canvas;
|
|
|
|
canvas.Clear(SKColors.White);
|
|
|
|
// create the shader
|
|
var colors = new SKColor[] {
|
|
new SKColor(0, 0, 255),
|
|
new SKColor(0, 255, 0)
|
|
};
|
|
var shader = SKShader.CreateRadialGradient(
|
|
new SKPoint(128, 128),
|
|
180,
|
|
colors,
|
|
null,
|
|
SKShaderTileMode.Clamp);
|
|
|
|
// use the shader
|
|
var paint = new SKPaint {
|
|
Shader = shader
|
|
};
|
|
canvas.DrawPaint(paint);
|
|
}
|
|
```
|
|
|
|
The example above produces the following:
|
|
|
|

|
|
|
|
### Two-point Conical Gradient Shader Example
|
|
|
|
```csharp
|
|
var info = new SKImageInfo(256, 256);
|
|
using (var surface = SKSurface.Create(info)) {
|
|
SKCanvas canvas = surface.Canvas;
|
|
|
|
canvas.Clear(SKColors.White);
|
|
|
|
// create the shader
|
|
var colors = new SKColor[] {
|
|
new SKColor(0, 0, 255),
|
|
new SKColor(0, 255, 0)
|
|
};
|
|
var shader = SKShader.CreateTwoPointConicalGradient(
|
|
new SKPoint(128, 128),
|
|
128,
|
|
new SKPoint(128, 16),
|
|
16,
|
|
colors,
|
|
null,
|
|
SKShaderTileMode.Clamp);
|
|
|
|
// use the shader
|
|
var paint = new SKPaint {
|
|
Shader = shader
|
|
};
|
|
canvas.DrawPaint(paint);
|
|
}
|
|
```
|
|
|
|
The example above produces the following:
|
|
|
|

|
|
|
|
### Sweep Gradient Shader Example
|
|
|
|
```csharp
|
|
var info = new SKImageInfo(256, 256);
|
|
using (var surface = SKSurface.Create(info)) {
|
|
SKCanvas canvas = surface.Canvas;
|
|
|
|
canvas.Clear(SKColors.White);
|
|
|
|
// create the shader
|
|
var colors = new SKColor[] {
|
|
new SKColor(0, 255, 255),
|
|
new SKColor(255, 0, 255),
|
|
new SKColor(255, 255, 0),
|
|
new SKColor(0, 255, 255)
|
|
};
|
|
var shader = SKShader.CreateSweepGradient(
|
|
new SKPoint(128, 128),
|
|
colors,
|
|
null);
|
|
|
|
// use the shader
|
|
var paint = new SKPaint {
|
|
Shader = shader
|
|
};
|
|
canvas.DrawPaint(paint);
|
|
}
|
|
```
|
|
|
|
The example above produces the following:
|
|
|
|

|
|
|
|
### Fractal Perlin Noise Shader Example
|
|
|
|
```csharp
|
|
var info = new SKImageInfo(256, 256);
|
|
using (var surface = SKSurface.Create(info)) {
|
|
SKCanvas canvas = surface.Canvas;
|
|
|
|
canvas.Clear(SKColors.White);
|
|
|
|
// create the shader
|
|
var shader = SKShader.CreatePerlinNoiseFractalNoise(0.5f, 0.5f, 4, 0);
|
|
|
|
// use the shader
|
|
var paint = new SKPaint {
|
|
Shader = shader
|
|
};
|
|
canvas.DrawPaint(paint);
|
|
}
|
|
```
|
|
|
|
The example above produces the following:
|
|
|
|

|
|
|
|
### Perlin Noise Turbulence Shader Example
|
|
|
|
```csharp
|
|
var info = new SKImageInfo(256, 256);
|
|
using (var surface = SKSurface.Create(info)) {
|
|
SKCanvas canvas = surface.Canvas;
|
|
|
|
canvas.Clear(SKColors.White);
|
|
|
|
// create the shader
|
|
var shader = SKShader.CreatePerlinNoiseTurbulence(0.05f, 0.05f, 4, 0);
|
|
|
|
// use the shader
|
|
var paint = new SKPaint {
|
|
Shader = shader
|
|
};
|
|
canvas.DrawPaint(paint);
|
|
}
|
|
```
|
|
|
|
The example above produces the following:
|
|
|
|

|
|
|
|
### Compose Shader Example
|
|
|
|
```csharp
|
|
var info = new SKImageInfo(256, 256);
|
|
using (var surface = SKSurface.Create(info)) {
|
|
SKCanvas canvas = surface.Canvas;
|
|
|
|
canvas.Clear(SKColors.White);
|
|
|
|
// create the first shader
|
|
var colors = new SKColor[] {
|
|
new SKColor(0, 255, 255),
|
|
new SKColor(255, 0, 255),
|
|
new SKColor(255, 255, 0),
|
|
new SKColor(0, 255, 255)
|
|
};
|
|
var sweep = SKShader.CreateSweepGradient(new SKPoint(128, 128), colors, null);
|
|
|
|
// create the second shader
|
|
var turbulence = SKShader.CreatePerlinNoiseTurbulence(0.05f, 0.05f, 4, 0);
|
|
|
|
// create the compose shader
|
|
var shader = SKShader.CreateCompose(sweep, turbulence, SKBlendMode.SrcOver);
|
|
|
|
// use the compose shader
|
|
var paint = new SKPaint {
|
|
Shader = shader
|
|
};
|
|
canvas.DrawPaint(paint);
|
|
}
|
|
```
|
|
|
|
The example above produces the following:
|
|
|
|

|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateBitmap(SkiaSharp.SKBitmap)">
|
|
<param name="src">The bitmap to use inside the shader.</param>
|
|
<summary>Creates a new shader that will draw with the specified bitmap.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If the bitmap cannot be used (has no pixels, or its dimensions exceed
|
|
implementation limits) then an empty shader may be returned. If the source
|
|
bitmap's color type is <xref:SkiaSharp.SKColorType.Alpha8> then that mask will
|
|
be colorized using the color on the paint.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateBitmap(SkiaSharp.SKBitmap,SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode)">
|
|
<param name="src">The bitmap to use inside the shader.</param>
|
|
<param name="tmx">The tiling mode to use when sampling the bitmap in the x-direction.</param>
|
|
<param name="tmy">The tiling mode to use when sampling the bitmap in the y-direction.</param>
|
|
<summary>Creates a new shader that will draw with the specified bitmap.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If the bitmap cannot be used (has no pixels, or its dimensions exceed
|
|
implementation limits) then an empty shader may be returned. If the source
|
|
bitmap's color type is <xref:SkiaSharp.SKColorType.Alpha8> then that mask will
|
|
be colorized using the color on the paint.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateBitmap(SkiaSharp.SKBitmap,SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="src">The bitmap to use inside the shader.</param>
|
|
<param name="tmx">The tiling mode to use when sampling the bitmap in the x-direction.</param>
|
|
<param name="tmy">The tiling mode to use when sampling the bitmap in the y-direction.</param>
|
|
<param name="localMatrix">The matrix to apply before applying the shader.</param>
|
|
<summary>Creates a new shader that will draw with the specified bitmap.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
If the bitmap cannot be used (has no pixels, or its dimensions exceed
|
|
implementation limits) then an empty shader may be returned. If the source
|
|
bitmap's color type is <xref:SkiaSharp.SKColorType.Alpha8> then that mask will
|
|
be colorized using the color on the paint.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateColor(SkiaSharp.SKColor)">
|
|
<param name="color">The color to paint.</param>
|
|
<summary>Creates a new shader that just draws the specified color.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateColor(SkiaSharp.SKColorF,SkiaSharp.SKColorSpace)">
|
|
<param name="color">The color to paint.</param>
|
|
<param name="colorspace">The colorspace to use.</param>
|
|
<summary>Creates a new shader that just draws the specified color.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateColorFilter(SkiaSharp.SKShader,SkiaSharp.SKColorFilter)">
|
|
<param name="shader">The shader to apply.</param>
|
|
<param name="filter">The color filter to apply.</param>
|
|
<summary>Creates a new shader that produces the same colors as invoking this shader and then applying the color filter.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateCompose(SkiaSharp.SKShader,SkiaSharp.SKShader)">
|
|
<param name="shaderA">The colors from this shader are seen as the destination by the blend mode.</param>
|
|
<param name="shaderB">The colors from this shader are seen as the source by the blend mode.</param>
|
|
<summary>Create a new compose shader, which combines two shaders by the <see cref="F:SkiaSharp.SKBlendMode.SrcOver" /> blend mode.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateCompose(SkiaSharp.SKShader,SkiaSharp.SKShader,SkiaSharp.SKBlendMode)">
|
|
<param name="shaderA">The colors from this shader are seen as the destination by the blend mode.</param>
|
|
<param name="shaderB">The colors from this shader are seen as the source by the blend mode.</param>
|
|
<param name="mode">The blend mode that combines the two shaders.</param>
|
|
<summary>Create a new compose shader, which combines two shaders by a blend mode.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateEmpty">
|
|
<summary>Creates a new "empty" shader that will not draw anything.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateImage(SkiaSharp.SKImage)">
|
|
<param name="src">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateImage(SkiaSharp.SKImage,SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode)">
|
|
<param name="src">To be added.</param>
|
|
<param name="tmx">To be added.</param>
|
|
<param name="tmy">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateImage(SkiaSharp.SKImage,SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="src">To be added.</param>
|
|
<param name="tmx">To be added.</param>
|
|
<param name="tmy">To be added.</param>
|
|
<param name="localMatrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateLerp(System.Single,SkiaSharp.SKShader,SkiaSharp.SKShader)">
|
|
<param name="weight">To be added.</param>
|
|
<param name="dst">To be added.</param>
|
|
<param name="src">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateLinearGradient(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKColor[],SkiaSharp.SKShaderTileMode)">
|
|
<param name="start">The start point for the gradient.</param>
|
|
<param name="end">The end point for the gradient.</param>
|
|
<param name="colors">The array colors to be distributed between the two points.</param>
|
|
<param name="mode">The tiling mode.</param>
|
|
<summary>Creates a shader that generates a linear gradient between the two specified points.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateLinearGradient(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKColor[],System.Single[],SkiaSharp.SKShaderTileMode)">
|
|
<param name="start">The start point for the gradient.</param>
|
|
<param name="end">The end point for the gradient.</param>
|
|
<param name="colors">The array colors to be distributed between the two points.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<param name="mode">The tiling mode.</param>
|
|
<summary>Creates a shader that generates a linear gradient between the two specified points.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateLinearGradient(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,SkiaSharp.SKShaderTileMode)">
|
|
<param name="start">To be added.</param>
|
|
<param name="end">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateLinearGradient(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKColor[],System.Single[],SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="start">The start point for the gradient.</param>
|
|
<param name="end">The end point for the gradient.</param>
|
|
<param name="colors">The array colors to be distributed between the two points.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<param name="mode">The tiling mode.</param>
|
|
<param name="localMatrix">The matrix to apply before applying the shader.</param>
|
|
<summary>Creates a shader that generates a linear gradient between the two specified points.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateLinearGradient(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[],SkiaSharp.SKShaderTileMode)">
|
|
<param name="start">To be added.</param>
|
|
<param name="end">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateLinearGradient(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[],SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="start">To be added.</param>
|
|
<param name="end">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<param name="localMatrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateLocalMatrix(SkiaSharp.SKShader,SkiaSharp.SKMatrix)">
|
|
<param name="shader">The shader to apply.</param>
|
|
<param name="localMatrix">The matrix to apply before applying the shader.</param>
|
|
<summary>Creates a shader that first applies the specified matrix and then applies the shader.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePerlinNoiseFractalNoise(System.Single,System.Single,System.Int32,System.Single)">
|
|
<param name="baseFrequencyX">The frequency in the x-direction in the range of 0..1.</param>
|
|
<param name="baseFrequencyY">The frequency in the y-direction in the range of 0..1.</param>
|
|
<param name="numOctaves">The number of octaves, usually fairly small.</param>
|
|
<param name="seed">The randomization seed.</param>
|
|
<summary>Creates a new shader that draws Perlin fractal noise.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePerlinNoiseFractalNoise(System.Single,System.Single,System.Int32,System.Single,SkiaSharp.SKPointI)">
|
|
<param name="baseFrequencyX">The frequency in the x-direction in the range of 0..1.</param>
|
|
<param name="baseFrequencyY">The frequency in the y-direction in the range of 0..1.</param>
|
|
<param name="numOctaves">The number of octaves, usually fairly small.</param>
|
|
<param name="seed">The randomization seed.</param>
|
|
<param name="tileSize">The tile size used to modify the frequencies so that the noise will be tileable for the given size.</param>
|
|
<summary>Creates a new shader that draws Perlin fractal noise.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePerlinNoiseFractalNoise(System.Single,System.Single,System.Int32,System.Single,SkiaSharp.SKSizeI)">
|
|
<param name="baseFrequencyX">To be added.</param>
|
|
<param name="baseFrequencyY">To be added.</param>
|
|
<param name="numOctaves">To be added.</param>
|
|
<param name="seed">To be added.</param>
|
|
<param name="tileSize">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePerlinNoiseImprovedNoise(System.Single,System.Single,System.Int32,System.Single)">
|
|
<param name="baseFrequencyX">To be added.</param>
|
|
<param name="baseFrequencyY">To be added.</param>
|
|
<param name="numOctaves">To be added.</param>
|
|
<param name="z">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePerlinNoiseTurbulence(System.Single,System.Single,System.Int32,System.Single)">
|
|
<param name="baseFrequencyX">The frequency in the x-direction in the range of 0..1.</param>
|
|
<param name="baseFrequencyY">The frequency in the y-direction in the range of 0..1.</param>
|
|
<param name="numOctaves">The number of octaves, usually fairly small.</param>
|
|
<param name="seed">The randomization seed.</param>
|
|
<summary>Creates a new shader that draws Perlin turbulence noise.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePerlinNoiseTurbulence(System.Single,System.Single,System.Int32,System.Single,SkiaSharp.SKPointI)">
|
|
<param name="baseFrequencyX">The frequency in the x-direction in the range of 0..1.</param>
|
|
<param name="baseFrequencyY">The frequency in the y-direction in the range of 0..1.</param>
|
|
<param name="numOctaves">The number of octaves, usually fairly small.</param>
|
|
<param name="seed">The randomization seed.</param>
|
|
<param name="tileSize">The tile size used to modify the frequencies so that the noise will be tileable for the given size.</param>
|
|
<summary>Creates a new shader that draws Perlin turbulence noise.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePerlinNoiseTurbulence(System.Single,System.Single,System.Int32,System.Single,SkiaSharp.SKSizeI)">
|
|
<param name="baseFrequencyX">To be added.</param>
|
|
<param name="baseFrequencyY">To be added.</param>
|
|
<param name="numOctaves">To be added.</param>
|
|
<param name="seed">To be added.</param>
|
|
<param name="tileSize">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePicture(SkiaSharp.SKPicture)">
|
|
<param name="src">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePicture(SkiaSharp.SKPicture,SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode)">
|
|
<param name="src">The picture to use inside the shader.</param>
|
|
<param name="tmx">The tiling mode to use when sampling the picture in the x-direction.</param>
|
|
<param name="tmy">The tiling mode to use when sampling the picture in the y-direction.</param>
|
|
<summary>Creates a new shader that will draw with the specified picture.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePicture(SkiaSharp.SKPicture,SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode,SkiaSharp.SKRect)">
|
|
<param name="src">The picture to use inside the shader.</param>
|
|
<param name="tmx">The tiling mode to use when sampling the picture in the x-direction.</param>
|
|
<param name="tmy">The tiling mode to use when sampling the picture in the y-direction.</param>
|
|
<param name="tile">The tile rectangle in picture coordinates.</param>
|
|
<summary>Creates a new shader that will draw with the specified picture.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The tile rectangle represents the subset (or superset) of the picture used when building a tile. It is not affected by
|
|
the local matrix and does not imply scaling (only translation and cropping).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreatePicture(SkiaSharp.SKPicture,SkiaSharp.SKShaderTileMode,SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix,SkiaSharp.SKRect)">
|
|
<param name="src">The picture to use inside the shader.</param>
|
|
<param name="tmx">The tiling mode to use when sampling the picture in the x-direction.</param>
|
|
<param name="tmy">The tiling mode to use when sampling the picture in the y-direction.</param>
|
|
<param name="localMatrix">The matrix to apply before applying the shader.</param>
|
|
<param name="tile">The tile rectangle in picture coordinates.</param>
|
|
<summary>Creates a new shader that will draw with the specified picture.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
The tile rectangle represents the subset (or superset) of the picture used when building a tile. It is not affected by
|
|
the local matrix and does not imply scaling (only translation and cropping).
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateRadialGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColor[],SkiaSharp.SKShaderTileMode)">
|
|
<param name="center">The center of the circle for this gradient.</param>
|
|
<param name="radius">The positive radius of the circle for this gradient.</param>
|
|
<param name="colors">The array colors to be distributed between the center and edge of the circle.</param>
|
|
<param name="mode">The tiling mode.</param>
|
|
<summary>Creates a shader that generates a radial gradient given the center and radius.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateRadialGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColor[],System.Single[],SkiaSharp.SKShaderTileMode)">
|
|
<param name="center">The center of the circle for this gradient.</param>
|
|
<param name="radius">The positive radius of the circle for this gradient.</param>
|
|
<param name="colors">The array colors to be distributed between the center and edge of the circle.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<param name="mode">The tiling mode.</param>
|
|
<summary>Creates a shader that generates a radial gradient given the center and radius.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateRadialGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,SkiaSharp.SKShaderTileMode)">
|
|
<param name="center">To be added.</param>
|
|
<param name="radius">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateRadialGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColor[],System.Single[],SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="center">The center of the circle for this gradient.</param>
|
|
<param name="radius">The positive radius of the circle for this gradient.</param>
|
|
<param name="colors">The array colors to be distributed between the center and edge of the circle.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<param name="mode">The tiling mode.</param>
|
|
<param name="localMatrix">The matrix to apply before applying the shader.</param>
|
|
<summary>Creates a shader that generates a radial gradient given the center and radius.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateRadialGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[],SkiaSharp.SKShaderTileMode)">
|
|
<param name="center">To be added.</param>
|
|
<param name="radius">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateRadialGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[],SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="center">To be added.</param>
|
|
<param name="radius">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<param name="localMatrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColor[])">
|
|
<param name="center">The coordinates of the center of the sweep.</param>
|
|
<param name="colors">The array colors to be distributed around the center.</param>
|
|
<summary>Creates a shader that generates a sweep gradient given a center.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColor[],System.Single[])">
|
|
<param name="center">The coordinates of the center of the sweep.</param>
|
|
<param name="colors">The array colors to be distributed around the center.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<summary>Creates a shader that generates a sweep gradient given a center.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace)">
|
|
<param name="center">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColor[],System.Single[],SkiaSharp.SKMatrix)">
|
|
<param name="center">The coordinates of the center of the sweep.</param>
|
|
<param name="colors">The array colors to be distributed around the center.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<param name="localMatrix">The matrix to apply before applying the shader.</param>
|
|
<summary>Creates a shader that generates a sweep gradient given a center.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[])">
|
|
<param name="center">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColor[],SkiaSharp.SKShaderTileMode,System.Single,System.Single)">
|
|
<param name="center">The coordinates of the center of the sweep.</param>
|
|
<param name="colors">The array colors to be distributed around the center.</param>
|
|
<param name="tileMode">The tiling mode.</param>
|
|
<param name="startAngle">The start of the angular range.</param>
|
|
<param name="endAngle">The end of the angular range.</param>
|
|
<summary>Creates a shader that generates a sweep gradient given a center.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[],SkiaSharp.SKMatrix)">
|
|
<param name="center">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<param name="localMatrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColor[],System.Single[],SkiaSharp.SKShaderTileMode,System.Single,System.Single)">
|
|
<param name="center">The coordinates of the center of the sweep.</param>
|
|
<param name="colors">The array colors to be distributed around the center.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<param name="tileMode">The tiling mode.</param>
|
|
<param name="startAngle">The start of the angular range.</param>
|
|
<param name="endAngle">The end of the angular range.</param>
|
|
<summary>Creates a shader that generates a sweep gradient given a center.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,SkiaSharp.SKShaderTileMode,System.Single,System.Single)">
|
|
<param name="center">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="tileMode">To be added.</param>
|
|
<param name="startAngle">To be added.</param>
|
|
<param name="endAngle">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColor[],System.Single[],SkiaSharp.SKShaderTileMode,System.Single,System.Single,SkiaSharp.SKMatrix)">
|
|
<param name="center">The coordinates of the center of the sweep.</param>
|
|
<param name="colors">The array colors to be distributed around the center.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<param name="tileMode">The tiling mode.</param>
|
|
<param name="startAngle">The start of the angular range.</param>
|
|
<param name="endAngle">The end of the angular range.</param>
|
|
<param name="localMatrix">The matrix to apply before applying the shader.</param>
|
|
<summary>Creates a shader that generates a sweep gradient given a center.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[],SkiaSharp.SKShaderTileMode,System.Single,System.Single)">
|
|
<param name="center">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<param name="tileMode">To be added.</param>
|
|
<param name="startAngle">To be added.</param>
|
|
<param name="endAngle">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateSweepGradient(SkiaSharp.SKPoint,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[],SkiaSharp.SKShaderTileMode,System.Single,System.Single,SkiaSharp.SKMatrix)">
|
|
<param name="center">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<param name="tileMode">To be added.</param>
|
|
<param name="startAngle">To be added.</param>
|
|
<param name="endAngle">To be added.</param>
|
|
<param name="localMatrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateTwoPointConicalGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColor[],SkiaSharp.SKShaderTileMode)">
|
|
<param name="start">The coordinates for the starting point.</param>
|
|
<param name="startRadius">The radius at the starting point.</param>
|
|
<param name="end">The coordinates for the end point.</param>
|
|
<param name="endRadius">The radius at the end point.</param>
|
|
<param name="colors">The array colors to be distributed between the two points.</param>
|
|
<param name="mode">The tiling mode.</param>
|
|
<summary>Creates a shader that generates a conical gradient given two circles.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateTwoPointConicalGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColor[],System.Single[],SkiaSharp.SKShaderTileMode)">
|
|
<param name="start">The coordinates for the starting point.</param>
|
|
<param name="startRadius">The radius at the starting point.</param>
|
|
<param name="end">The coordinates for the end point.</param>
|
|
<param name="endRadius">The radius at the end point.</param>
|
|
<param name="colors">The array colors to be distributed between the two points.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<param name="mode">The tiling mode.</param>
|
|
<summary>Creates a shader that generates a conical gradient given two circles.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or null on error.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateTwoPointConicalGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,SkiaSharp.SKShaderTileMode)">
|
|
<param name="start">To be added.</param>
|
|
<param name="startRadius">To be added.</param>
|
|
<param name="end">To be added.</param>
|
|
<param name="endRadius">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateTwoPointConicalGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColor[],System.Single[],SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="start">The coordinates for the starting point.</param>
|
|
<param name="startRadius">The radius at the starting point.</param>
|
|
<param name="end">The coordinates for the end point.</param>
|
|
<param name="endRadius">The radius at the end point.</param>
|
|
<param name="colors">The array colors to be distributed between the two points.</param>
|
|
<param name="colorPos">The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors.</param>
|
|
<param name="mode">The tiling mode.</param>
|
|
<param name="localMatrix">The matrix to apply before applying the shader.</param>
|
|
<summary>Creates a shader that generates a conical gradient given two circles.</summary>
|
|
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateTwoPointConicalGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[],SkiaSharp.SKShaderTileMode)">
|
|
<param name="start">To be added.</param>
|
|
<param name="startRadius">To be added.</param>
|
|
<param name="end">To be added.</param>
|
|
<param name="endRadius">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.CreateTwoPointConicalGradient(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPoint,System.Single,SkiaSharp.SKColorF[],SkiaSharp.SKColorSpace,System.Single[],SkiaSharp.SKShaderTileMode,SkiaSharp.SKMatrix)">
|
|
<param name="start">To be added.</param>
|
|
<param name="startRadius">To be added.</param>
|
|
<param name="end">To be added.</param>
|
|
<param name="endRadius">To be added.</param>
|
|
<param name="colors">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="colorPos">To be added.</param>
|
|
<param name="mode">To be added.</param>
|
|
<param name="localMatrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKShader" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKShader" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.WithColorFilter(SkiaSharp.SKColorFilter)">
|
|
<param name="filter">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKShader.WithLocalMatrix(SkiaSharp.SKMatrix)">
|
|
<param name="localMatrix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKShaderTileMode">
|
|
<summary>Indications on how the shader should handle drawing outside the original bounds.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKShaderTileMode.Clamp">
|
|
<summary>Replicate the edge color.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKShaderTileMode.Decal">
|
|
<summary>To be added.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKShaderTileMode.Mirror">
|
|
<summary>Repeat the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKShaderTileMode.Repeat">
|
|
<summary>Repeat the shader's image horizontally and vertically.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKSize">
|
|
<summary>Stores an ordered pair of floating-point numbers describing the width and height of a rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKSize(SkiaSharp.SKPoint)">
|
|
<param name="pt">The offset to use as the dimensions of the new point.</param>
|
|
<summary>Creates a new size from the offset of a point.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKSize(System.Single,System.Single)">
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<summary>Creates a new size with a given width and height.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.Add(SkiaSharp.SKSize,SkiaSharp.SKSize)">
|
|
<param name="sz1">The first <see cref="T:SkiaSharp.SKSize" /> structure to add.</param>
|
|
<param name="sz2">The second <see cref="T:SkiaSharp.SKSize" /> structure to add.</param>
|
|
<summary>Adds the width and height of one <see cref="T:SkiaSharp.SKSize" /> structure to the width and height of another <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<returns>A <see cref="T:SkiaSharp.SKSize" /> structure that is the result of the addition operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKSize.Empty">
|
|
<summary>Represents a new instance of the <see cref="T:SkiaSharp.SKSize" /> class with member data left uninitialized.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.Equals(SkiaSharp.SKSize)">
|
|
<param name="obj">The <see cref="T:SkiaSharp.SKSize" /> to test.</param>
|
|
<summary>Tests to see whether the specified object is a <see cref="T:SkiaSharp.SKSize" /> structure with the same dimensions as this <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> has the same coordinates as this <see cref="T:SkiaSharp.SKSize" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.Equals(System.Object)">
|
|
<param name="obj">The <see cref="T:System.Object" /> to test.</param>
|
|
<summary>Tests to see whether the specified object is a <see cref="T:SkiaSharp.SKSize" /> structure with the same dimensions as this <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> is a <see cref="T:SkiaSharp.SKSize" /> and has the same coordinates as this <see cref="T:SkiaSharp.SKSize" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.GetHashCode">
|
|
<summary>Returns a hash code for this <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<returns>An integer value that specifies a hash value for this <see cref="T:SkiaSharp.SKSize" /> structure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSize.Height">
|
|
<summary>Gets or sets the vertical component of this <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSize.IsEmpty">
|
|
<summary>Gets a value that indicates whether this <see cref="T:SkiaSharp.SKSize" /> structure has zero width and height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.op_Addition(SkiaSharp.SKSize,SkiaSharp.SKSize)">
|
|
<param name="sz1">The first <see cref="T:SkiaSharp.SKSize" /> structure to add.</param>
|
|
<param name="sz2">The second <see cref="T:SkiaSharp.SKSize" /> structure to add.</param>
|
|
<summary>Adds the width and height of one <see cref="T:SkiaSharp.SKSize" /> structure to the width and height of another <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<returns>A <see cref="T:SkiaSharp.SKSize" /> structure that is the result of the addition operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.op_Equality(SkiaSharp.SKSize,SkiaSharp.SKSize,SkiaSharp.SKSize,SkiaSharp.SKSize)">
|
|
<param name="sz1">The <see cref="T:SkiaSharp.SKSize" /> structure on the left side of the equality operator.</param>
|
|
<param name="left">The <see cref="T:SkiaSharp.SKSize" /> structure on the left side of the equality operator.</param>
|
|
<param name="sz2">The <see cref="T:SkiaSharp.SKSize" /> structure on the right of the equality operator.</param>
|
|
<param name="right">The <see cref="T:SkiaSharp.SKSize" /> structure on the right of the equality operator.</param>
|
|
<summary>Tests whether two <see cref="T:SkiaSharp.SKSize" /> structures are equal.</summary>
|
|
<returns>This operator returns true if both <see cref="T:SkiaSharp.SKSize" /> structures have equal <see cref="P:SkiaSharp.SKSize.Width" /> and <see cref="P:SkiaSharp.SKSize.Height" />; otherwise, false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.op_Explicit(SkiaSharp.SKSize)~SkiaSharp.SKPoint">
|
|
<param name="size">The <see cref="T:SkiaSharp.SKSize" /> structure to be converted.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKSize" /> structure to a <see cref="T:SkiaSharp.SKPoint" /> structure.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKPoint" /> structure structure to which this operator converts.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.op_Implicit(SkiaSharp.SKSizeI)~SkiaSharp.SKSize">
|
|
<param name="size">The <see cref="T:SkiaSharp.SKSizeI" /> structure to be converted.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKSizeI" /> structure to a <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKSize" /> structure structure to which this operator converts.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.op_Inequality(SkiaSharp.SKSize,SkiaSharp.SKSize,SkiaSharp.SKSize,SkiaSharp.SKSize)">
|
|
<param name="sz1">The <see cref="T:SkiaSharp.SKSize" /> structure that is to the left of the inequality operator.</param>
|
|
<param name="left">The <see cref="T:SkiaSharp.SKSize" /> structure that is to the left of the inequality operator.</param>
|
|
<param name="sz2">The <see cref="T:SkiaSharp.SKSize" /> structure that is to the right of the inequality operator.</param>
|
|
<param name="right">The <see cref="T:SkiaSharp.SKSize" /> structure that is to the right of the inequality operator.</param>
|
|
<summary>Tests whether two <see cref="T:SkiaSharp.SKSize" /> structures are different.</summary>
|
|
<returns>This operator returns true if either of the <see cref="P:SkiaSharp.SKSize.Width" /> and <see cref="P:SkiaSharp.SKSize.Height" /> properties of the two <see cref="T:SkiaSharp.SKSize" /> structures are unequal; otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.op_Subtraction(SkiaSharp.SKSize,SkiaSharp.SKSize)">
|
|
<param name="sz1">The <see cref="T:SkiaSharp.SKSize" /> structure on the left side of the subtraction operator.</param>
|
|
<param name="sz2">The <see cref="T:SkiaSharp.SKSize" /> structure on the right side of the subtraction operator.</param>
|
|
<summary>Subtracts the width and height of one <see cref="T:SkiaSharp.SKSize" /> structure from the width and height of another <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<returns>A <see cref="T:SkiaSharp.SKSize" /> that is the result of the subtraction operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.Subtract(SkiaSharp.SKSize,SkiaSharp.SKSize)">
|
|
<param name="sz1">The <see cref="T:SkiaSharp.SKSize" /> structure on the left side of the subtraction operator.</param>
|
|
<param name="sz2">The <see cref="T:SkiaSharp.SKSize" /> structure on the right side of the subtraction operator.</param>
|
|
<summary>Subtracts the width and height of one <see cref="T:SkiaSharp.SKSize" /> structure from the width and height of another <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<returns>A <see cref="T:SkiaSharp.SKSize" /> that is the result of the subtraction operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.ToPoint">
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKSize" /> structure to a <see cref="T:SkiaSharp.SKPoint" /> structure.</summary>
|
|
<returns>Returns a <see cref="T:SkiaSharp.SKPoint" /> structure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.ToSizeI">
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKSize" /> structure to a <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<returns>Returns a <see cref="T:SkiaSharp.SKSizeI" /> structure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSize.ToString">
|
|
<summary>Converts this <see cref="T:SkiaSharp.SKSize" /> to a human readable string.</summary>
|
|
<returns>A string that represents this <see cref="T:SkiaSharp.SKSize" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSize.Width">
|
|
<summary>Gets or sets the horizontal component of this <see cref="T:SkiaSharp.SKSize" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKSizeI">
|
|
<summary>Stores an ordered pair of integers describing the width and height of a rectangle.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKSizeI(SkiaSharp.SKPointI)">
|
|
<param name="pt">The offset to use as the dimensions of the new point.</param>
|
|
<summary>Creates a new size from the offset of a point.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKSizeI(System.Int32,System.Int32)">
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<summary>Creates a new size with a given width and height.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.Add(SkiaSharp.SKSizeI,SkiaSharp.SKSizeI)">
|
|
<param name="sz1">The first <see cref="T:SkiaSharp.SKSizeI" /> structure to add.</param>
|
|
<param name="sz2">The second <see cref="T:SkiaSharp.SKSizeI" /> structure to add.</param>
|
|
<summary>Adds the width and height of one <see cref="T:SkiaSharp.SKSizeI" /> structure to the width and height of another <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<returns>A <see cref="T:SkiaSharp.SKSizeI" /> structure that is the result of the addition operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKSizeI.Empty">
|
|
<summary>Represents a new instance of the <see cref="T:SkiaSharp.SKSizeI" /> class with member data left uninitialized.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.Equals(SkiaSharp.SKSizeI)">
|
|
<param name="obj">The <see cref="T:SkiaSharp.SKSizeI" /> to test.</param>
|
|
<summary>Tests to see whether the specified object is a <see cref="T:SkiaSharp.SKSizeI" /> structure with the same dimensions as this <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> has the same coordinates as this <see cref="T:SkiaSharp.SKSizeI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.Equals(System.Object)">
|
|
<param name="obj">The <see cref="T:System.Object" /> to test.</param>
|
|
<summary>Tests to see whether the specified object is a <see cref="T:SkiaSharp.SKSizeI" /> structure with the same dimensions as this <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<returns>This method returns true if <paramref name="obj" /> is a <see cref="T:SkiaSharp.SKSizeI" /> and has the same coordinates as this <see cref="T:SkiaSharp.SKSizeI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.GetHashCode">
|
|
<summary>Returns a hash code for this <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<returns>An integer value that specifies a hash value for this <see cref="T:SkiaSharp.SKSizeI" /> structure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSizeI.Height">
|
|
<summary>Gets or sets the vertical component of this <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSizeI.IsEmpty">
|
|
<summary>Gets a value that indicates whether this <see cref="T:SkiaSharp.SKSizeI" /> structure has zero width and height.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.op_Addition(SkiaSharp.SKSizeI,SkiaSharp.SKSizeI)">
|
|
<param name="sz1">The first <see cref="T:SkiaSharp.SKSizeI" /> structure to add.</param>
|
|
<param name="sz2">The second <see cref="T:SkiaSharp.SKSizeI" /> structure to add.</param>
|
|
<summary>Adds the width and height of one <see cref="T:SkiaSharp.SKSizeI" /> structure to the width and height of another <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<returns>A <see cref="T:SkiaSharp.SKSizeI" /> structure that is the result of the addition operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.op_Equality(SkiaSharp.SKSizeI,SkiaSharp.SKSizeI,SkiaSharp.SKSizeI,SkiaSharp.SKSizeI)">
|
|
<param name="sz1">The <see cref="T:SkiaSharp.SKSizeI" /> structure on the left side of the equality operator.</param>
|
|
<param name="left">The <see cref="T:SkiaSharp.SKSizeI" /> structure on the left side of the equality operator.</param>
|
|
<param name="sz2">The <see cref="T:SkiaSharp.SKSizeI" /> structure on the right of the equality operator.</param>
|
|
<param name="right">The <see cref="T:SkiaSharp.SKSizeI" /> structure on the right of the equality operator.</param>
|
|
<summary>Tests whether two <see cref="T:SkiaSharp.SKSizeI" /> structures are equal.</summary>
|
|
<returns>This operator returns true if both <see cref="T:SkiaSharp.SKSizeI" /> structures have equal <see cref="P:SkiaSharp.SKSizeI.Width" /> and <see cref="P:SkiaSharp.SKSizeI.Height" />; otherwise, false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.op_Explicit(SkiaSharp.SKSizeI)~SkiaSharp.SKPointI">
|
|
<param name="size">The <see cref="T:SkiaSharp.SKSizeI" /> structure to be converted.</param>
|
|
<summary>Converts the specified <see cref="T:SkiaSharp.SKSizeI" /> structure to a <see cref="T:SkiaSharp.SKPointI" /> structure.</summary>
|
|
<returns>The <see cref="T:SkiaSharp.SKPointI" /> structure structure to which this operator converts.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.op_Inequality(SkiaSharp.SKSizeI,SkiaSharp.SKSizeI,SkiaSharp.SKSizeI,SkiaSharp.SKSizeI)">
|
|
<param name="sz1">The <see cref="T:SkiaSharp.SKSizeI" /> structure that is to the left of the inequality operator.</param>
|
|
<param name="left">The <see cref="T:SkiaSharp.SKSizeI" /> structure that is to the left of the inequality operator.</param>
|
|
<param name="sz2">The <see cref="T:SkiaSharp.SKSizeI" /> structure that is to the right of the inequality operator.</param>
|
|
<param name="right">The <see cref="T:SkiaSharp.SKSizeI" /> structure that is to the right of the inequality operator.</param>
|
|
<summary>Tests whether two <see cref="T:SkiaSharp.SKSizeI" /> structures are different.</summary>
|
|
<returns>This operator returns true if either of the <see cref="P:SkiaSharp.SKSizeI.Width" /> and <see cref="P:SkiaSharp.SKSizeI.Height" /> properties of the two <see cref="T:SkiaSharp.SKSizeI" /> structures are unequal; otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.op_Subtraction(SkiaSharp.SKSizeI,SkiaSharp.SKSizeI)">
|
|
<param name="sz1">The <see cref="T:SkiaSharp.SKSizeI" /> structure on the left side of the subtraction operator.</param>
|
|
<param name="sz2">The <see cref="T:SkiaSharp.SKSizeI" /> structure on the right side of the subtraction operator.</param>
|
|
<summary>Subtracts the width and height of one <see cref="T:SkiaSharp.SKSizeI" /> structure from the width and height of another <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<returns>A <see cref="T:SkiaSharp.SKSizeI" /> that is the result of the subtraction operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.Subtract(SkiaSharp.SKSizeI,SkiaSharp.SKSizeI)">
|
|
<param name="sz1">The <see cref="T:SkiaSharp.SKSizeI" /> structure on the left side of the subtraction operator.</param>
|
|
<param name="sz2">The <see cref="T:SkiaSharp.SKSizeI" /> structure on the right side of the subtraction operator.</param>
|
|
<summary>Subtracts the width and height of one <see cref="T:SkiaSharp.SKSizeI" /> structure from the width and height of another <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<returns>A <see cref="T:SkiaSharp.SKSizeI" /> that is the result of the subtraction operation.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.ToPointI">
|
|
<summary>Converts a <see cref="T:SkiaSharp.SKSizeI" /> structure to a <see cref="T:SkiaSharp.SKPointI" /> structure.</summary>
|
|
<returns>Returns a <see cref="T:SkiaSharp.SKPointI" /> structure.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSizeI.ToString">
|
|
<summary>Converts this <see cref="T:SkiaSharp.SKSizeI" /> to a human readable string.</summary>
|
|
<returns>A string that represents this <see cref="T:SkiaSharp.SKSizeI" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSizeI.Width">
|
|
<summary>Gets or sets the horizontal component of this <see cref="T:SkiaSharp.SKSizeI" /> structure.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKStream">
|
|
<summary>An abstraction for a source of bytes, which can be backed by memory, or a file, or something else.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.GetMemoryBase">
|
|
<summary>Returns the memory address of the data if the stream is a memory stream.</summary>
|
|
<returns>Returns the memory address of the data, or IntPtr.Zero if the stream is not a memory stream.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKStream.HasLength">
|
|
<summary>Gets a value indicating whether this stream can report it's total length.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKStream.HasPosition">
|
|
<summary>Gets a value indicating whether this stream can report it's current position.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKStream.IsAtEnd">
|
|
<summary>Gets a value indicating whether all the bytes in the stream have been read.</summary>
|
|
<value />
|
|
<remarks>This method may return true if there was an error, and the stream cannot be read anymore.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKStream.Length">
|
|
<summary>Gets the total length of the stream. If this is not supported, the length will be reported as 0.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.Move(System.Int32)">
|
|
<param name="offset">The relative offset.</param>
|
|
<summary>Seeks to an relative offset in the stream.</summary>
|
|
<returns>Returns true if seeking is supported and the seek was successful, otherwise false.</returns>
|
|
<remarks>If an attempt is made to move to a position outside the stream, the position will be set to the closest point within the stream (beginning or end).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.Move(System.Int64)">
|
|
<param name="offset">The relative offset.</param>
|
|
<summary>Seeks to an relative offset in the stream.</summary>
|
|
<returns>Returns true if seeking is supported and the seek was successful, otherwise false.</returns>
|
|
<remarks>If an attempt is made to move to a position outside the stream, the position will be set to the closest point within the stream (beginning or end).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.Peek(System.IntPtr,System.Int32)">
|
|
<param name="buffer">The buffer to read into.</param>
|
|
<param name="size">The number of bytes to read.</param>
|
|
<summary>Attempt to peek at <paramref name="size" /> bytes.</summary>
|
|
<returns>Returns the number of bytes actually peeked/copied.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKStream.Position">
|
|
<summary>Gets the current position in the stream. If this is not supported, the position will be reported as 0.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.Read(System.Byte[],System.Int32)">
|
|
<param name="buffer">The buffer to read into.</param>
|
|
<param name="size">The number of bytes to read.</param>
|
|
<summary>Reads a copy of the specified number of bytes into the provided buffer.</summary>
|
|
<returns>Returns the number of bytes actually read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.Read(System.IntPtr,System.Int32)">
|
|
<param name="buffer">The buffer to read into.</param>
|
|
<param name="size">The number of bytes to read.</param>
|
|
<summary>Reads a copy of the specified number of bytes into the provided buffer.</summary>
|
|
<returns>Returns the number of bytes actually read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadBool">
|
|
<summary>Read a single boolean.</summary>
|
|
<returns>Returns the boolean that was read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadBool(System.Boolean@)">
|
|
<param name="buffer">The boolean that was read.</param>
|
|
<summary>Read a single boolean.</summary>
|
|
<returns>Returns true if the read was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadByte">
|
|
<summary>Read a single byte.</summary>
|
|
<returns>Returns the byte that was read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadByte(System.Byte@)">
|
|
<param name="buffer">The byte that was read.</param>
|
|
<summary>Read a single byte.</summary>
|
|
<returns>Returns true if the read was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadInt16">
|
|
<summary>Read a single 16-bit integer.</summary>
|
|
<returns>Returns the 16-bit integer that was read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadInt16(System.Int16@)">
|
|
<param name="buffer">The 16-bit integer that was read.</param>
|
|
<summary>Read a single 16-bit integer.</summary>
|
|
<returns>Returns true if the read was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadInt32">
|
|
<summary>Read a single 32-bit integer.</summary>
|
|
<returns>Returns the 32-bit integer that was read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadInt32(System.Int32@)">
|
|
<param name="buffer">The 32-bit integer that was read.</param>
|
|
<summary>Read a single 32-bit integer.</summary>
|
|
<returns>Returns true if the read was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadSByte">
|
|
<summary>Read a single, signed byte.</summary>
|
|
<returns>Returns the signed byte that was read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadSByte(System.SByte@)">
|
|
<param name="buffer">The signed byte that was read.</param>
|
|
<summary>Read a single, signed byte.</summary>
|
|
<returns>Returns true if the read was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadUInt16">
|
|
<summary>Read a single, unsigned 16-bit integer.</summary>
|
|
<returns>Returns the unsigned 16-bit integer that was read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadUInt16(System.UInt16@)">
|
|
<param name="buffer">The unsigned 16-bit integer that was read.</param>
|
|
<summary>Read a single, unsigned 16-bit integer.</summary>
|
|
<returns>Returns true if the read was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadUInt32">
|
|
<summary>Read a single, unsigned 32-bit integer.</summary>
|
|
<returns>Returns the unsigned 32-bit integer that was read.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.ReadUInt32(System.UInt32@)">
|
|
<param name="buffer">The unsigned 32-bit integer that was read.</param>
|
|
<summary>Read a single, unsigned 32-bit integer.</summary>
|
|
<returns>Returns true if the read was successful, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.Rewind">
|
|
<summary>Rewinds to the beginning of the stream.</summary>
|
|
<returns>Returns true if the stream is known to be at the beginning after this call returns.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.Seek(System.Int32)">
|
|
<param name="position">The absolute position.</param>
|
|
<summary>Seeks to an absolute position in the stream.</summary>
|
|
<returns>Returns true if seeking is supported and the seek was successful, otherwise false.</returns>
|
|
<remarks>If an attempt is made to move to a position outside the stream, the position will be set to the closest point within the stream (beginning or end).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKStream.Skip(System.Int32)">
|
|
<param name="size">The number of bytes to skip.</param>
|
|
<summary>Moves the current position on by the specified number of bytes.</summary>
|
|
<returns>Returns the actual number bytes that could be skipped.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKStreamAsset">
|
|
<summary>An abstract, seekable stream with a known length.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKStreamMemory">
|
|
<summary>An abstract, memory-based stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKStreamRewindable">
|
|
<summary>An abstract, rewindable stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKStreamSeekable">
|
|
<summary>An abstract, rewindable stream that supports the seek operation.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKStrokeCap">
|
|
<summary>Various options for <see cref="P:SkiaSharp.SKPaint.StrokeCap" />.</summary>
|
|
<remarks>This is the treatment that is applied to the beginning and end of each non-closed contour (e.g. lines).</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKStrokeCap.Butt">
|
|
<summary>Begin/end contours with no extension.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKStrokeCap.Round">
|
|
<summary>Begin/end contours with a semi-circle extension.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKStrokeCap.Square">
|
|
<summary>Begin/end contours with a half square extension.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKStrokeJoin">
|
|
<summary>Join style for stroking operations.</summary>
|
|
<remarks>This is the treatment that is applied to corners in paths and rectangles.</remarks>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKStrokeJoin.Bevel">
|
|
<summary>Connect path segments with a flat bevel join.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKStrokeJoin.Miter">
|
|
<summary>Connect path segments with a sharp join.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKStrokeJoin.Round">
|
|
<summary>Connect path segments with a round join.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKSurface">
|
|
<summary>Represents the backend/results of drawing to a canvas.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSurface.Canvas">
|
|
<summary>Gets the canvas for this surface which can be used for drawing into it.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSurface.Context">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo)">
|
|
<param name="info">Contains the image configuration parameters.</param>
|
|
<summary>Creates a new surface with the specified image parameters.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer with the parameters specified in <paramref name="info" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixmap.</param>
|
|
<summary>Creates a new surface with the specified pixmap.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendRenderTargetDesc)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing render target.</param>
|
|
<summary>Wraps a pre-existing 3D API render target as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<summary>Wraps a pre-existing 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing OpenGL texture.</param>
|
|
<summary>Wraps a pre-existing OpenGL texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface from the specified image parameters and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer with the parameters specified in <paramref name="info&nbsp;" />and the properties specified in <paramref name="props" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,SkiaSharp.SKSurfaceProps)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface from the specified image parameters and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer with the parameters specified in <paramref name="info&nbsp;" />and the properties specified in <paramref name="props" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,System.Int32)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="rowBytes">The number of bytes per row in the pixel buffer.</param>
|
|
<summary>Creates a new surface from the specified image parameters.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer with the parameters specified in <paramref name="info&nbsp;" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,System.IntPtr)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="pixels">The pointer to an in memory-buffer that can hold the image as specified.</param>
|
|
<summary>Creates a new surface with the specified image parameters using a provided buffer.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKPixmap,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="pixmap">The pixmap.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface with the specified pixmap and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKPixmap,SkiaSharp.SKSurfaceProps)">
|
|
<param name="pixmap">The pixmap.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface with the specified pixmap and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="renderTarget">The description of the existing render target.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<summary>Wraps a pre-existing 3D API render target as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendRenderTargetDesc,SkiaSharp.SKSurfaceProps)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing render target.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing 3D API render target as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<summary>Wraps a pre-existing 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc,SkiaSharp.SKSurfaceProps)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc,SkiaSharp.SKSurfaceProps)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing OpenGL texture.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing OpenGL texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,System.Boolean,SkiaSharp.SKImageInfo)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="budgeted">Whether an allocation should count against a cache budget.</param>
|
|
<param name="info">The image configuration parameters.</param>
|
|
<summary>Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.SKColorType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="renderTarget">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,System.Boolean,SkiaSharp.SKImageInfo)">
|
|
<param name="context">To be added.</param>
|
|
<param name="budgeted">To be added.</param>
|
|
<param name="info">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,System.Int32,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="rowBytes">The number of bytes per row in the pixel buffer.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface from the specified image parameters and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer with the parameters specified in <paramref name="info" />and the properties specified in <paramref name="props" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="pixels">The pointer to an in memory-buffer that can hold the image as specified.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface from the specified image parameters and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer with the parameters specified in <paramref name="info" />and the properties specified in <paramref name="props" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="pixels">The pointer to an in memory-buffer that can hold the image as specified.</param>
|
|
<param name="rowBytes">The number of bytes per row in the pixel buffer.</param>
|
|
<summary>Creates a new surface with the specified image parameters using a provided buffer.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer that will be backend by the in-memory buffer provided in <paramref name="pixels" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="renderTarget">The description of the existing render target.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<summary>Wraps a pre-existing backend 3D API render target as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="renderTarget">The description of the existing render target.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API render target as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,System.Boolean,SkiaSharp.SKImageInfo,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="budgeted">Whether an allocation should count against a cache budget.</param>
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,System.Boolean,SkiaSharp.SKImageInfo,System.Int32)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="budgeted">Whether an allocation should count against a cache budget.</param>
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="sampleCount">The number of samples.</param>
|
|
<summary>Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="renderTarget">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">To be added.</param>
|
|
<param name="renderTarget">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,System.Boolean,SkiaSharp.SKImageInfo,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">To be added.</param>
|
|
<param name="budgeted">To be added.</param>
|
|
<param name="info">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,System.Boolean,SkiaSharp.SKImageInfo,System.Int32)">
|
|
<param name="context">To be added.</param>
|
|
<param name="budgeted">To be added.</param>
|
|
<param name="info">To be added.</param>
|
|
<param name="sampleCount">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="pixels">The pointer to an in memory-buffer that can hold the image as specified.</param>
|
|
<param name="rowBytes">The number of bytes per row in the pixel buffer.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface from the specified image parameters, the provided buffer and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer that will be backend by the in-memory buffer provided in <paramref name="pixels" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKSurfaceProps)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="pixels">The pointer to an in memory-buffer that can hold the image as specified.</param>
|
|
<param name="rowBytes">The number of bytes per row in the pixel buffer.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface from the specified image parameters, the provided buffer and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer that will be backend by the in-memory buffer provided in <paramref name="pixels" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(System.Int32,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType)">
|
|
<param name="width">The desired width for the surface.</param>
|
|
<param name="height">The desired height for the surface.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="alphaType">The transparency mode to use for the surface.</param>
|
|
<summary>Creates a new surface with the specified image parameters.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>This will create a buffer that will be backend by the in-memory buffer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="renderTarget">The description of the existing render target.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="colorspace">The colorspace to use for the surface.</param>
|
|
<summary>Wraps a pre-existing backend 3D API render target as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="renderTarget">The description of the existing render target.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API render target as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,System.Boolean,SkiaSharp.SKImageInfo,System.Int32,SkiaSharp.GRSurfaceOrigin)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="budgeted">Whether an allocation should count against a cache budget.</param>
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<summary>Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,System.Boolean,SkiaSharp.SKImageInfo,System.Int32,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="budgeted">Whether an allocation should count against a cache budget.</param>
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="sampleCount">The number of samples.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,System.Boolean,SkiaSharp.SKImageInfo,System.Int32,SkiaSharp.SKSurfaceProps)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="budgeted">Whether an allocation should count against a cache budget.</param>
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="sampleCount">The number of samples.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace)">
|
|
<param name="context">To be added.</param>
|
|
<param name="renderTarget">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">To be added.</param>
|
|
<param name="renderTarget">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="sampleCount">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,System.Boolean,SkiaSharp.SKImageInfo,System.Int32,SkiaSharp.GRSurfaceOrigin)">
|
|
<param name="context">To be added.</param>
|
|
<param name="budgeted">To be added.</param>
|
|
<param name="info">To be added.</param>
|
|
<param name="sampleCount">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,System.Boolean,SkiaSharp.SKImageInfo,System.Int32,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">To be added.</param>
|
|
<param name="budgeted">To be added.</param>
|
|
<param name="info">To be added.</param>
|
|
<param name="sampleCount">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKSurfaceReleaseDelegate,System.Object)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="pixels">The pointer to an in memory-buffer that can hold the image as specified.</param>
|
|
<param name="rowBytes">The number of bytes per row in the pixel buffer.</param>
|
|
<param name="releaseProc">The delegate to invoke when the surface is about to be disposed.</param>
|
|
<param name="context">The user data to use when invoking the delegate.</param>
|
|
<summary>Creates a new surface with the specified image parameters using a provided buffer.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(System.Int32,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,SkiaSharp.SKSurfaceProps)">
|
|
<param name="width">The desired width for the surface.</param>
|
|
<param name="height">The desired height for the surface.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="alphaType">The transparency mode to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface with the specified image parameters and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="renderTarget">The description of the existing render target.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="colorspace">The colorspace to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API render target as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="colorspace">The colorspace to use for the surface.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendRenderTarget,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">To be added.</param>
|
|
<param name="renderTarget">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="sampleCount">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="sampleCount">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,SkiaSharp.SKSurfaceReleaseDelegate,System.Object,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="pixels">The pointer to an in memory-buffer that can hold the image as specified.</param>
|
|
<param name="rowBytes">The number of bytes per row in the pixel buffer.</param>
|
|
<param name="releaseProc">The delegate to invoke when the surface is about to be disposed.</param>
|
|
<param name="context">The user data to use when invoking the delegate.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface with the specified image parameters using a provided buffer.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(System.Int32,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,System.IntPtr,System.Int32)">
|
|
<param name="width">The desired width for the surface.</param>
|
|
<param name="height">The desired height for the surface.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="alphaType">The transparency mode to use for the surface.</param>
|
|
<param name="pixels">The pointer to an in memory-buffer that can hold the image as specified.</param>
|
|
<param name="rowBytes">The number of bytes per row in the pixel buffer.</param>
|
|
<summary>Creates a new surface with the specified image parameters using a provided buffer.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="colorspace">The colorspace to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRContext,System.Boolean,SkiaSharp.SKImageInfo,System.Int32,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKSurfaceProperties,System.Boolean)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="budgeted">Whether an allocation should count against a cache budget.</param>
|
|
<param name="info">The image configuration parameters.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<param name="shouldCreateWithMips">A hint that the surface will host mip map images.</param>
|
|
<summary>Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">To be added.</param>
|
|
<param name="texture">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="sampleCount">To be added.</param>
|
|
<param name="colorType">To be added.</param>
|
|
<param name="colorspace">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(SkiaSharp.GRRecordingContext,System.Boolean,SkiaSharp.SKImageInfo,System.Int32,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKSurfaceProperties,System.Boolean)">
|
|
<param name="context">To be added.</param>
|
|
<param name="budgeted">To be added.</param>
|
|
<param name="info">To be added.</param>
|
|
<param name="sampleCount">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<param name="props">To be added.</param>
|
|
<param name="shouldCreateWithMips">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Create(System.Int32,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKAlphaType,System.IntPtr,System.Int32,SkiaSharp.SKSurfaceProps)">
|
|
<param name="width">The desired width for the surface.</param>
|
|
<param name="height">The desired height for the surface.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="alphaType">The transparency mode to use for the surface.</param>
|
|
<param name="pixels">The pointer to an in memory-buffer that can hold the image as specified.</param>
|
|
<param name="rowBytes">The number of bytes per row in the pixel buffer.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Creates a new surface with the specified image parameters using a provided buffer and surface properties.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>The <see cref="F:SkiaSharp.GRBackendTextureDescFlags.RenderTarget" /> flag must be set on <see cref="T:SkiaSharp.GRBackendTextureDesc" /> for this to succeed. The texture must remain valid for the lifetime of the surface.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing OpenGL texture.</param>
|
|
<summary>Wraps a pre-existing backend OpenGL texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>The <see cref="F:SkiaSharp.GRBackendTextureDescFlags.RenderTarget" /> flag must be set on <see cref="T:SkiaSharp.GRGlBackendTextureDesc" /> for this to succeed. The texture must remain valid for the lifetime of the surface. </remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTextureDesc,SkiaSharp.SKSurfaceProps)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing texture.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>The <see cref="F:SkiaSharp.GRBackendTextureDescFlags.RenderTarget" /> flag must be set on <see cref="T:SkiaSharp.GRBackendTextureDesc" /> for this to succeed. The texture must remain valid for the lifetime of the surface. </remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRGlBackendTextureDesc,SkiaSharp.SKSurfaceProps)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="desc">The description of the existing OpenGL texture.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend OpenGL texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks>The <see cref="F:SkiaSharp.GRBackendTextureDescFlags.RenderTarget" /> flag must be set on <see cref="T:SkiaSharp.GRGlBackendTextureDesc" /> for this to succeed. The texture must remain valid for the lifetime of the surface. </remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="colorspace">The colorspace to use for the surface.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateAsRenderTarget(SkiaSharp.GRContext,SkiaSharp.GRBackendTexture,SkiaSharp.GRSurfaceOrigin,System.Int32,SkiaSharp.SKColorType,SkiaSharp.SKColorSpace,SkiaSharp.SKSurfaceProperties)">
|
|
<param name="context">The graphics context.</param>
|
|
<param name="texture">The description of the existing texture.</param>
|
|
<param name="origin">The origin of the texture.</param>
|
|
<param name="sampleCount">The number of samples per pixel.</param>
|
|
<param name="colorType">The color type to use for the surface.</param>
|
|
<param name="colorspace">The colorspace to use for the surface.</param>
|
|
<param name="props">The surface property configuration.</param>
|
|
<summary>Wraps a pre-existing backend 3D API texture as a surface.</summary>
|
|
<returns>Returns the new surface if it could be created and the configuration is supported, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.CreateNull(System.Int32,System.Int32)">
|
|
<param name="width">The desired width for the surface.</param>
|
|
<param name="height">The desired height for the surface.</param>
|
|
<summary>Creates a new surface without any backing pixels.</summary>
|
|
<returns>Returns the new surface if it could be created, otherwise <see langword="null" />.</returns>
|
|
<remarks>Drawing to the <see cref="T:SkiaSharp.SKCanvas" /> returned from <see cref="P:SkiaSharp.SKSurface.Canvas" /> has no effect. Calling <see cref="M:SkiaSharp.SKSurface.Snapshot" /> on the returned <see cref="T:SkiaSharp.SKSurface" /> returns <see langword="null" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKSurface" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKSurface" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Draw(SkiaSharp.SKCanvas,System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="canvas">The canvas to draw on.</param>
|
|
<param name="x">The destination x-coordinate for the surface.</param>
|
|
<param name="y">The destination y-coordinate for the surface.</param>
|
|
<param name="paint">The paint to use when drawing the surface, or <see langword="null" />.</param>
|
|
<summary>Draws the current surface on the specified canvas.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Flush">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Flush(System.Boolean,System.Boolean)">
|
|
<param name="submit">To be added.</param>
|
|
<param name="synchronous">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.PeekPixels">
|
|
<summary>Returns the pixels, if they are available.</summary>
|
|
<returns>Returns the pixels, if they are available, otherwise <see langword="null" />.</returns>
|
|
<remarks>If the pixels are available, then the surface is only valid until the surface changes in any way, in which case the pixmap becomes invalid.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.PeekPixels(SkiaSharp.SKPixmap)">
|
|
<param name="pixmap">The pixmap to receive the pixel information.</param>
|
|
<summary>Returns the pixmap of the surface.</summary>
|
|
<returns>Returns <see langword="true" /> on success, or <see langword="false" /> if the surface does not have access to pixel data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.ReadPixels(SkiaSharp.SKImageInfo,System.IntPtr,System.Int32,System.Int32,System.Int32)">
|
|
<param name="dstInfo">The image information describing the destination pixel buffer.</param>
|
|
<param name="dstPixels">The pixel buffer to read the pixel data into.</param>
|
|
<param name="dstRowBytes">The number of bytes in each row of in the destination buffer.</param>
|
|
<param name="srcX">The source x-coordinate to start reading from.</param>
|
|
<param name="srcY">The source y-coordinate to start reading from.</param>
|
|
<summary>Copies the pixels from the surface into the specified buffer.</summary>
|
|
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
|
<remarks>This method may return <see langword="false" /> if the source rectangle [<paramref name="srcX" />, <paramref name="srcY" />, dstInfo.Width, dstInfo.Height] does not intersect the surface, or if the color type/alpha type could not be converted to the destination types.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Snapshot">
|
|
<summary>Takes a snapshot of the surface and returns it as an image.</summary>
|
|
<returns>An <see cref="T:SkiaSharp.SKImage" /> that contains a snapshot of the current image.</returns>
|
|
<remarks>You can use this method to take an <see cref="T:SkiaSharp.SKImage" /> snapshot of the current state of the surface.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurface.Snapshot(SkiaSharp.SKRectI)">
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSurface.SurfaceProperties">
|
|
<summary>Gets the surface property configuration.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSurface.SurfaceProps">
|
|
<summary>Gets the surface property configuration.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKSurfaceProperties">
|
|
<summary>Describes properties and constraints of a given <see cref="T:SkiaSharp.SKSurface" />.</summary>
|
|
<remarks>The rendering engine can parse these during drawing, and can sometimes optimize its performance (e.g. disabling an expensive feature).</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKSurfaceProperties(SkiaSharp.SKPixelGeometry)">
|
|
<param name="pixelGeometry">The description of how the LCD strips are arranged for each pixel.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKSurfaceProperties" /> instance.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKSurfaceProperties(SkiaSharp.SKSurfaceProps)">
|
|
<param name="props">The properties of the surface.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKSurfaceProperties" /> instance.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKSurfaceProperties(SkiaSharp.SKSurfacePropsFlags,SkiaSharp.SKPixelGeometry)">
|
|
<param name="flags">The flags to use when creating the surface.</param>
|
|
<param name="pixelGeometry">The LCD geometry of each pixel on the surface.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKSurfaceProperties" /> instance.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKSurfaceProperties(System.UInt32,SkiaSharp.SKPixelGeometry)">
|
|
<param name="flags">The flags to use when creating the surface.</param>
|
|
<param name="pixelGeometry">The LCD geometry of each pixel on the surface.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKSurfaceProperties" /> instance.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurfaceProperties.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKSurfaceProperties" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKSurfaceProperties" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurfaceProperties.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSurfaceProperties.Flags">
|
|
<summary>Gets or sets the flags.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSurfaceProperties.IsUseDeviceIndependentFonts">
|
|
<summary>Gets a value indicating whether the surface should use device independent fonts.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSurfaceProperties.PixelGeometry">
|
|
<summary>Gets or sets the LCD geometry of each pixel on the surface.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKSurfaceProps">
|
|
<summary>Describes properties and constraints of a given <see cref="T:SkiaSharp.SKSurface" />.</summary>
|
|
<remarks>The rendering engine can parse these during drawing, and can sometimes optimize its performance (e.g. disabling an expensive feature).</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurfaceProps.Equals(SkiaSharp.SKSurfaceProps)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurfaceProps.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSurfaceProps.Flags">
|
|
<summary>Gets or sets the flags.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurfaceProps.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurfaceProps.op_Equality(SkiaSharp.SKSurfaceProps,SkiaSharp.SKSurfaceProps)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSurfaceProps.op_Inequality(SkiaSharp.SKSurfaceProps,SkiaSharp.SKSurfaceProps)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKSurfaceProps.PixelGeometry">
|
|
<summary>Gets or sets the LCD geometry of each pixel on the surface.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKSurfacePropsFlags">
|
|
<summary>Flags for the <see cref="T:SkiaSharp.SKSurfaceProps" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKSurfacePropsFlags.None">
|
|
<summary>Use default properties.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKSurfacePropsFlags.UseDeviceIndependentFonts">
|
|
<summary>Use device independent fonts.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKSurfaceReleaseDelegate">
|
|
<param name="address">The memory address of the pixels being released.</param>
|
|
<param name="context">The user data that was provided when creating the surface.</param>
|
|
<summary>The delegate that is used when releasing the memory for a surface.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKSvgCanvas">
|
|
<summary>A specialized <see cref="T:SkiaSharp.SKCanvas" /> which generates SVG commands from its draw calls.</summary>
|
|
<remarks>The canvas may buffer some drawing calls, so the output is not guaranteed to be valid or complete until the canvas instance is deleted.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSvgCanvas.Create(SkiaSharp.SKRect,SkiaSharp.SKWStream)">
|
|
<param name="bounds">To be added.</param>
|
|
<param name="stream">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSvgCanvas.Create(SkiaSharp.SKRect,SkiaSharp.SKXmlWriter)">
|
|
<param name="bounds">The initial SVG viewport (viewBox attribute on the root SVG element).</param>
|
|
<param name="writer">The writer to receive the XML data.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKSvgCanvas" /> which writes to the specified XML writer.</summary>
|
|
<returns>Returns the new canvas.</returns>
|
|
<remarks>Ownership of the XML writer is not transfered to the canvas, but it must stay valid during the lifetime of the returned canvas.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSvgCanvas.Create(SkiaSharp.SKRect,System.IO.Stream)">
|
|
<param name="bounds">To be added.</param>
|
|
<param name="stream">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKSwizzle">
|
|
<summary>Various utility methods for when swizzling pixels.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSwizzle.SwapRedBlue(System.Span{System.Byte})">
|
|
<param name="pixels">The pixel buffer to swizzle.</param>
|
|
<summary>Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA)</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSwizzle.SwapRedBlue(System.IntPtr,System.Int32)">
|
|
<param name="pixels">The pixel buffer to swizzle.</param>
|
|
<param name="count">The size of the pixel buffers.</param>
|
|
<summary>Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA)</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSwizzle.SwapRedBlue(System.ReadOnlySpan{System.Byte},System.Int32)">
|
|
<param name="pixels">The pixel buffer to swizzle.</param>
|
|
<param name="count">The size of the pixel buffers.</param>
|
|
<summary>Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA)</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSwizzle.SwapRedBlue(System.IntPtr,System.IntPtr,System.Int32)">
|
|
<param name="dest">The destination pixel buffer.</param>
|
|
<param name="src">The source pixel buffer.</param>
|
|
<param name="count">The size of the pixel buffers.</param>
|
|
<summary>Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA)</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKSwizzle.SwapRedBlue(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte},System.Int32)">
|
|
<param name="dest">The destination pixel buffer.</param>
|
|
<param name="src">The source pixel buffer.</param>
|
|
<param name="count">The size of the pixel buffers.</param>
|
|
<summary>Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA)</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKTextAlign">
|
|
<summary>Possible text alignment values.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTextAlign.Center">
|
|
<summary>Center the text.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTextAlign.Left">
|
|
<summary>Left align the text.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTextAlign.Right">
|
|
<summary>Right align the text.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKTextBlob">
|
|
<summary>Represents multiple text runs of glyphs and positions.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTextBlob.Bounds">
|
|
<summary>Gets the conservative blob bounding box.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CountIntercepts(System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="upperBounds">To be added.</param>
|
|
<param name="lowerBounds">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.Create(System.ReadOnlySpan{System.Char},SkiaSharp.SKFont,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.Create(System.String,SkiaSharp.SKFont,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.Create(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.Create(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreateHorizontal(System.ReadOnlySpan{System.Char},SkiaSharp.SKFont,System.ReadOnlySpan{System.Single},System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreateHorizontal(System.String,SkiaSharp.SKFont,System.ReadOnlySpan{System.Single},System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreateHorizontal(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,System.ReadOnlySpan{System.Single},System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreateHorizontal(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,System.ReadOnlySpan{System.Single},System.Single)">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreatePathPositioned(System.ReadOnlySpan{System.Char},SkiaSharp.SKFont,SkiaSharp.SKPath,SkiaSharp.SKTextAlign,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="path">To be added.</param>
|
|
<param name="textAlign">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreatePathPositioned(System.String,SkiaSharp.SKFont,SkiaSharp.SKPath,SkiaSharp.SKTextAlign,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="path">To be added.</param>
|
|
<param name="textAlign">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreatePathPositioned(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,SkiaSharp.SKPath,SkiaSharp.SKTextAlign,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="path">To be added.</param>
|
|
<param name="textAlign">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreatePathPositioned(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,SkiaSharp.SKPath,SkiaSharp.SKTextAlign,SkiaSharp.SKPoint)">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="path">To be added.</param>
|
|
<param name="textAlign">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreatePositioned(System.ReadOnlySpan{System.Char},SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreatePositioned(System.String,SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreatePositioned(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreatePositioned(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreateRotationScale(System.ReadOnlySpan{System.Char},SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKRotationScaleMatrix})">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreateRotationScale(System.String,SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKRotationScaleMatrix})">
|
|
<param name="text">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreateRotationScale(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKRotationScaleMatrix})">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.CreateRotationScale(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding,SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKRotationScaleMatrix})">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKTextBlob" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKTextBlob" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.GetIntercepts(System.Single,System.Single,SkiaSharp.SKPaint)">
|
|
<param name="upperBounds">To be added.</param>
|
|
<param name="lowerBounds">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlob.GetIntercepts(System.Single,System.Single,System.Span{System.Single},SkiaSharp.SKPaint)">
|
|
<param name="upperBounds">To be added.</param>
|
|
<param name="lowerBounds">To be added.</param>
|
|
<param name="intervals">To be added.</param>
|
|
<param name="paint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTextBlob.UniqueId">
|
|
<summary>Gets the unique, non-zero value representing the text blob.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKTextBlobBuilder">
|
|
<summary>A builder object that is used to create a <see cref="T:SkiaSharp.SKTextBlob" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKTextBlobBuilder">
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKTextBlobBuilder" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{System.Single})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.UInt16[],System.Single[])">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(System.ReadOnlySpan{System.UInt16},SkiaSharp.SKFont,System.ReadOnlySpan{System.Single},System.Single)">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{System.Single},System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.UInt16[],System.Single[],SkiaSharp.SKRect)">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.UInt32})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<param name="text">The chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.UInt16[],System.Single[],System.Byte[],System.UInt32[])">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.UInt16[],System.Single[],System.String,System.UInt32[])">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<param name="text">The chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.UInt32},System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.UInt16[],System.Single[],System.Byte[],System.UInt32[],SkiaSharp.SKRect)">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddHorizontalRun(SkiaSharp.SKPaint,System.Single,System.UInt16[],System.Single[],System.String,System.UInt32[],SkiaSharp.SKRect)">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="y">The vertical offset within the blob.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The horizontal positions of each glyph.</param>
|
|
<param name="text">The chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new horizontally-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPathPositionedRun(System.ReadOnlySpan{System.UInt16},SkiaSharp.SKFont,System.ReadOnlySpan{System.Single},System.ReadOnlySpan{SkiaSharp.SKPoint},SkiaSharp.SKPath,SkiaSharp.SKTextAlign)">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="glyphWidths">To be added.</param>
|
|
<param name="glyphOffsets">To be added.</param>
|
|
<param name="path">To be added.</param>
|
|
<param name="textAlign">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.UInt16[],SkiaSharp.SKPoint[])">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(System.ReadOnlySpan{System.UInt16},SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKPoint})">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{SkiaSharp.SKPoint},System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.UInt16[],SkiaSharp.SKPoint[],SkiaSharp.SKRect)">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{SkiaSharp.SKPoint},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.UInt32})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="text">The chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.UInt16[],SkiaSharp.SKPoint[],System.Byte[],System.UInt32[])">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.UInt16[],SkiaSharp.SKPoint[],System.String,System.UInt32[])">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="text">The chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{SkiaSharp.SKPoint},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.UInt32},System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.UInt16[],SkiaSharp.SKPoint[],System.Byte[],System.UInt32[],SkiaSharp.SKRect)">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddPositionedRun(SkiaSharp.SKPaint,System.UInt16[],SkiaSharp.SKPoint[],System.String,System.UInt32[],SkiaSharp.SKRect)">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="positions">The positions of each glyph.</param>
|
|
<param name="text">The chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new fully-positioned run to the builder.</summary>
|
|
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRotationScaleRun(System.ReadOnlySpan{System.UInt16},SkiaSharp.SKFont,System.ReadOnlySpan{SkiaSharp.SKRotationScaleMatrix})">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="positions">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(System.ReadOnlySpan{System.UInt16},SkiaSharp.SKFont,SkiaSharp.SKPoint)">
|
|
<param name="glyphs">To be added.</param>
|
|
<param name="font">To be added.</param>
|
|
<param name="origin">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.ReadOnlySpan{System.UInt16})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.UInt16[])">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.ReadOnlySpan{System.UInt16},System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.UInt16[],SkiaSharp.SKRect)">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.UInt32})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.UInt16[],System.Byte[],System.UInt32[])">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.UInt16[],System.String,System.UInt32[])">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="text">The chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.ReadOnlySpan{System.UInt16},System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.UInt32},System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.UInt16[],System.Byte[],System.UInt32[],SkiaSharp.SKRect)">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="text">The UTF-8 chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AddRun(SkiaSharp.SKPaint,System.Single,System.Single,System.UInt16[],System.String,System.UInt32[],SkiaSharp.SKRect)">
|
|
<param name="font">The font to be used for this run.</param>
|
|
<param name="x">The x-position of the origin of this run.</param>
|
|
<param name="y">The y-position of the origin of this run.</param>
|
|
<param name="glyphs">The glyphs for this run.</param>
|
|
<param name="text">The chacracter information for this run.</param>
|
|
<param name="clusters">The glyph's cluster information.</param>
|
|
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
|
|
<summary>Adds a new deafult-positioned run to the builder.</summary>
|
|
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateHorizontalRun(SkiaSharp.SKPaint,System.Int32,System.Single)">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateHorizontalRun(SkiaSharp.SKFont,System.Int32,System.Single,System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateHorizontalRun(SkiaSharp.SKPaint,System.Int32,System.Single,System.Int32)">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="textByteCount">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateHorizontalRun(SkiaSharp.SKPaint,System.Int32,System.Single,System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateHorizontalRun(SkiaSharp.SKPaint,System.Int32,System.Single,System.Int32,System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="textByteCount">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocatePositionedRun(SkiaSharp.SKPaint,System.Int32)">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocatePositionedRun(SkiaSharp.SKFont,System.Int32,System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocatePositionedRun(SkiaSharp.SKPaint,System.Int32,System.Int32)">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="textByteCount">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocatePositionedRun(SkiaSharp.SKPaint,System.Int32,System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocatePositionedRun(SkiaSharp.SKPaint,System.Int32,System.Int32,System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="textByteCount">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateRotationScaleRun(SkiaSharp.SKFont,System.Int32)">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateRun(SkiaSharp.SKPaint,System.Int32,System.Single,System.Single)">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateRun(SkiaSharp.SKFont,System.Int32,System.Single,System.Single,System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateRun(SkiaSharp.SKPaint,System.Int32,System.Single,System.Single,System.Int32)">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="textByteCount">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateRun(SkiaSharp.SKPaint,System.Int32,System.Single,System.Single,System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.AllocateRun(SkiaSharp.SKPaint,System.Int32,System.Single,System.Single,System.Int32,System.Nullable{SkiaSharp.SKRect})">
|
|
<param name="font">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="x">To be added.</param>
|
|
<param name="y">To be added.</param>
|
|
<param name="textByteCount">To be added.</param>
|
|
<param name="bounds">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.Build">
|
|
<summary>Create the <see cref="T:SkiaSharp.SKTextBlob" /> from all the added runs.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKTextBlob" /> if there were runs, otherwise <see langword="null" />.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKTextBlobBuilder" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKTextBlobBuilder" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTextBlobBuilder.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKTextEncoding">
|
|
<summary>Possible text encodings.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTextEncoding.GlyphId">
|
|
<summary>The buffer contains glyph ids.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTextEncoding.Utf16">
|
|
<summary>The buffer contains UTF-16 encoded characters.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTextEncoding.Utf32">
|
|
<summary>The buffer contains UTF-32 encoded characters.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTextEncoding.Utf8">
|
|
<summary>The buffer contains UTF-8 encoded characters.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKTraceMemoryDump">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="C:SkiaSharp.SKTraceMemoryDump(System.Boolean,System.Boolean)">
|
|
<param name="detailedDump">To be added.</param>
|
|
<param name="dumpWrappedObjects">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTraceMemoryDump.DisposeNative">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTraceMemoryDump.OnDumpNumericValue(System.String,System.String,System.String,System.UInt64)">
|
|
<param name="dumpName">To be added.</param>
|
|
<param name="valueName">To be added.</param>
|
|
<param name="units">To be added.</param>
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTraceMemoryDump.OnDumpStringValue(System.String,System.String,System.String)">
|
|
<param name="dumpName">To be added.</param>
|
|
<param name="valueName">To be added.</param>
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKTransferFunctionBehavior">
|
|
<summary>Various flags to be used with <see cref="P:SkiaSharp.SKCodecOptions.PremulBehavior" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTransferFunctionBehavior.Ignore">
|
|
<summary>Premultiplies, unpremultiplies, and blends ignoring the transfer function. Pixels are treated as if they are linear, regardless of their transfer function encoding.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTransferFunctionBehavior.Respect">
|
|
<summary>Converts to a linear space before premultiplying, unpremultiplying, or blending.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKTrimPathEffectMode">
|
|
<summary>Represents the type of trimming to perform.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTrimPathEffectMode.Inverted">
|
|
<summary>Remove the path between the start and stop, preserving [0, start] and [stop, 1]</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTrimPathEffectMode.Normal">
|
|
<summary>Trim the path around the start and stop, preserving [start, stop]</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKTypeface">
|
|
<summary>Represents a specific typeface and intrinsic style of a font.</summary>
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This is used in the paint, along with optionally algorithmic settings like
|
|
<xref:SkiaSharp.SKPaint.TextSize?displayProperty=nameWithType>,
|
|
<xref:SkiaSharp.SKPaint.TextSkewX?displayProperty=nameWithType>,
|
|
<xref:SkiaSharp.SKPaint.TextScaleX?displayProperty=nameWithType>, and
|
|
<xref:SkiaSharp.SKPaint.FakeBoldText?displayProperty=nameWithType>
|
|
to specify how text appears when drawn (and measured).
|
|
|
|
Typeface objects are immutable, and so they can be shared between threads.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CharsToGlyphs(System.String,System.UInt16[]@)">
|
|
<param name="chars">The string containing characters.</param>
|
|
<param name="glyphs">Destination for the corresponding glyph IDs for each character.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a string of characters.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CharsToGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKEncoding,System.UInt16[]@)">
|
|
<param name="str">The buffer of character codes.</param>
|
|
<param name="strlen">The length of the buffer.</param>
|
|
<param name="encoding">How the character codes are encoded.</param>
|
|
<param name="glyphs">Destination for the corresponding glyph IDs for each character.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.ContainsGlyph(System.Int32)">
|
|
<param name="codepoint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.ContainsGlyphs(System.ReadOnlySpan{System.Char})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.ContainsGlyphs(System.ReadOnlySpan{System.Int32})">
|
|
<param name="codepoints">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.ContainsGlyphs(System.String)">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.ContainsGlyphs(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding)">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.ContainsGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding)">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CountGlyphs(System.ReadOnlySpan{System.Char})">
|
|
<param name="str">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CountGlyphs(System.String)">
|
|
<param name="str">The string containing characters.</param>
|
|
<summary>Returns the number of glyphs in the string.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of string.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CountGlyphs(System.Byte[],SkiaSharp.SKEncoding)">
|
|
<param name="str">The buffer containing character codes.</param>
|
|
<param name="encoding">How the character are encoded.</param>
|
|
<summary>Returns the number of glyphs in the buffer.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of the buffer.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CountGlyphs(System.Byte[],SkiaSharp.SKTextEncoding)">
|
|
<param name="str">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CountGlyphs(System.ReadOnlySpan{System.Byte},SkiaSharp.SKEncoding)">
|
|
<param name="str">The buffer containing character codes.</param>
|
|
<param name="encoding">How the character are encoded.</param>
|
|
<summary>Returns the number of glyphs in the buffer.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of the buffer.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CountGlyphs(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding)">
|
|
<param name="str">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CountGlyphs(System.String,SkiaSharp.SKEncoding)">
|
|
<param name="str">The text containing characters.</param>
|
|
<param name="encoding">How the characters are to be encoded.</param>
|
|
<summary>Returns the number of glyphs on the string.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of chars.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CountGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKEncoding)">
|
|
<param name="str">The buffer of character codes.</param>
|
|
<param name="strLen">The length of the buffer.</param>
|
|
<param name="encoding">How the characters are encoded.</param>
|
|
<summary>Returns the number of glyphs on the specified buffer with the specified length and encoding.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of chars.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CountGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding)">
|
|
<param name="str">To be added.</param>
|
|
<param name="strLen">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.CreateDefault">
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKTypeface" /> which is the default, Normal typeface.</summary>
|
|
<returns />
|
|
<remarks>This will never be null.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.Default">
|
|
<summary>Gets the default, Normal typeface.</summary>
|
|
<value />
|
|
<remarks>This will never be <see langword="null" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKTypeface" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKTypeface" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.FamilyName">
|
|
<summary>Gets the family name for the typeface.</summary>
|
|
<value />
|
|
<remarks>The family name will always be returned encoded as UTF8, but the language of the name is whatever the host platform chooses.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.FontSlant">
|
|
<summary>Gets the font slant for the typeface.</summary>
|
|
<value />
|
|
<remarks>This may be one of the values in <see cref="T:SkiaSharp.SKFontStyleSlant" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.FontStyle">
|
|
<summary>Gets the font style for the typeface.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.FontWeight">
|
|
<summary>Gets the font weight for the typeface.</summary>
|
|
<value />
|
|
<remarks>This may be one of the values in <see cref="T:SkiaSharp.SKFontStyleWeight" />.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.FontWidth">
|
|
<summary>Gets the font width for the typeface.</summary>
|
|
<value />
|
|
<remarks>This may be one of the values in <see cref="T:SkiaSharp.SKFontStyleWidth" />.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromData(SkiaSharp.SKData,System.Int32)">
|
|
<param name="data">The input data.</param>
|
|
<param name="index">The font face index.</param>
|
|
<summary>Returns a new typeface given data.</summary>
|
|
<returns>Returns a new typeface, or <paramref name="null" /> if the file does not exist, or is not a valid font file.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromFamilyName(System.String)">
|
|
<param name="familyName">The name of the font family. May be <paramref name="null" />.</param>
|
|
<summary>Returns a new instance to a typeface that most closely matches the requested family name and style.</summary>
|
|
<returns>Returns to the closest-matching typeface.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromFamilyName(System.String,SkiaSharp.SKFontStyle)">
|
|
<param name="familyName">The name of the font family. May be <paramref name="null" />.</param>
|
|
<param name="style">The style (normal, bold, italic) of the typeface.</param>
|
|
<summary>Returns a new instance to a typeface that most closely matches the requested family name and style.</summary>
|
|
<returns>Returns to the closest-matching typeface.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromFamilyName(System.String,SkiaSharp.SKTypefaceStyle)">
|
|
<param name="familyName">The name of the font family. May be <paramref name="null" />.</param>
|
|
<param name="style">The style (normal, bold, italic) of the typeface.</param>
|
|
<summary>Returns a new instance to a typeface that most closely matches the requested family name and style.</summary>
|
|
<returns>Returns to the closest-matching typeface.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromFamilyName(System.String,SkiaSharp.SKFontStyleWeight,SkiaSharp.SKFontStyleWidth,SkiaSharp.SKFontStyleSlant)">
|
|
<param name="familyName">The name of the font family. May be <paramref name="null" />.</param>
|
|
<param name="weight">The weight of the typeface.</param>
|
|
<param name="width">The width of the typeface.</param>
|
|
<param name="slant">The slant of the typeface.</param>
|
|
<summary>Return a new instance to a typeface that most closely matches the requested family name and style.</summary>
|
|
<returns>Returns to the closest-matching typeface.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromFamilyName(System.String,System.Int32,System.Int32,SkiaSharp.SKFontStyleSlant)">
|
|
<param name="familyName">The name of the font family. May be <paramref name="null" />.</param>
|
|
<param name="weight">The weight of the typeface.</param>
|
|
<param name="width">The width of the typeface.</param>
|
|
<param name="slant">The slant of the typeface.</param>
|
|
<summary>Return a new instance to a typeface that most closely matches the requested family name and style.</summary>
|
|
<returns>Returns to the closest-matching typeface.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromFile(System.String,System.Int32)">
|
|
<param name="path">The path of the file.</param>
|
|
<param name="index">The font face index.</param>
|
|
<summary>Returns a new typeface given a file. </summary>
|
|
<returns>Returns a new typeface, or <paramref name="null" /> if the file does not exist, or is not a valid font file.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromStream(SkiaSharp.SKStreamAsset,System.Int32)">
|
|
<param name="stream">The input stream.</param>
|
|
<param name="index">The font face index.</param>
|
|
<summary>Returns a new typeface given a stream. Ownership of the stream is transferred, so the caller must not reference it again.</summary>
|
|
<returns>Returns a new typeface, or <paramref name="null" /> if the file does not exist, or is not a valid font file.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromStream(System.IO.Stream,System.Int32)">
|
|
<param name="stream">The input stream.</param>
|
|
<param name="index">The font face index.</param>
|
|
<summary>Returns a new typeface given a stream. Ownership of the stream is transferred, so the caller must not reference it again.</summary>
|
|
<returns>Returns a new typeface, or <paramref name="null" /> if the file does not exist, or is not a valid font file.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.FromTypeface(SkiaSharp.SKTypeface,SkiaSharp.SKTypefaceStyle)">
|
|
<param name="typeface">The typeface to use for the family name.</param>
|
|
<param name="style">The style (normal, bold, italic) of the type face.</param>
|
|
<summary>Return a new reference to the typeface that most closely matches the requested typeface and specified style</summary>
|
|
<returns>Returns to the closest-matching typeface.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyph(System.Int32)">
|
|
<param name="codepoint">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.ReadOnlySpan{System.Char})">
|
|
<param name="text">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.ReadOnlySpan{System.Int32})">
|
|
<param name="codepoints">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.String)">
|
|
<param name="text">The string of characters.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a string of characters.</summary>
|
|
<returns>Returns the corresponding glyph IDs for each character.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.Byte[],SkiaSharp.SKEncoding)">
|
|
<param name="text">The buffer of character codes.</param>
|
|
<param name="encoding">How the character codes are encoded.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding.</summary>
|
|
<returns>Returns the corresponding glyph IDs for each character.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.ReadOnlySpan{System.Byte},SkiaSharp.SKEncoding)">
|
|
<param name="text">The buffer of character codes.</param>
|
|
<param name="encoding">How the character codes are encoded.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding.</summary>
|
|
<returns>Returns the corresponding glyph IDs for each character.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding)">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.String,SkiaSharp.SKEncoding)">
|
|
<param name="text">The string of characters.</param>
|
|
<param name="encoding">How the characters are to be encoded.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a string of characters, of the specified encoding.</summary>
|
|
<returns>Returns the corresponding glyph IDs for each character.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.String,System.UInt16[]@)">
|
|
<param name="text">The string of characters.</param>
|
|
<param name="glyphs">Destination for the corresponding glyph IDs for each character.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a string of characters.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.Byte[],SkiaSharp.SKEncoding,System.UInt16[]@)">
|
|
<param name="text">The buffer of character codes.</param>
|
|
<param name="encoding">How the character codes are encoded.</param>
|
|
<param name="glyphs">Destination for the corresponding glyph IDs for each character.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKEncoding)">
|
|
<param name="text">The buffer of character codes.</param>
|
|
<param name="length">The length of the buffer.</param>
|
|
<param name="encoding">How the character codes are encoded.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding.</summary>
|
|
<returns>Returns the corresponding glyph IDs for each character.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding)">
|
|
<param name="text">To be added.</param>
|
|
<param name="length">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.ReadOnlySpan{System.Byte},SkiaSharp.SKEncoding,System.UInt16[]@)">
|
|
<param name="text">The buffer of character codes.</param>
|
|
<param name="encoding">How the character codes are encoded.</param>
|
|
<param name="glyphs">Destination for the corresponding glyph IDs for each character.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.String,SkiaSharp.SKEncoding,System.UInt16[]@)">
|
|
<param name="text">The string of characters.</param>
|
|
<param name="encoding">How the characters are to be encoded.</param>
|
|
<param name="glyphs">Destination for the corresponding glyph IDs for each character.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a string of characters.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetGlyphs(System.IntPtr,System.Int32,SkiaSharp.SKEncoding,System.UInt16[]@)">
|
|
<param name="text">The buffer of character codes.</param>
|
|
<param name="length">The length of the buffer.</param>
|
|
<param name="encoding">How the character codes are encoded.</param>
|
|
<param name="glyphs">Destination for the corresponding glyph IDs for each character.</param>
|
|
<summary>Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding.</summary>
|
|
<returns>The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetKerningPairAdjustments(System.ReadOnlySpan{System.UInt16})">
|
|
<param name="glyphs">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetTableData(System.UInt32)">
|
|
<param name="tag">The table tag to get the data for.</param>
|
|
<summary>Returns the contents of the table data for the specified tag.</summary>
|
|
<returns>Returns the contents, if it exists, otherwise throws.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetTableSize(System.UInt32)">
|
|
<param name="tag">The tag to retrieve.</param>
|
|
<summary>Returns the size of the data for the specified tag.</summary>
|
|
<returns>Returns the size of the data.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.GetTableTags">
|
|
<summary>Returns the list of table tags in the font.</summary>
|
|
<returns />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.GlyphCount">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.IsBold">
|
|
<summary>Gets a value indicating whether the typeface claims to be a bold typeface.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
A typeface is understood to be bold when the weight is greater than or equal to
|
|
600 or <xref:SkiaSharp.SKFontStyleWeight.SemiBold>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.IsFixedPitch">
|
|
<summary>Gets a value indicating whether the typeface claims to be fixed-pitch.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
This does not guarentee that the advance widths will not vary as this is a
|
|
style bit on the typeface.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.IsItalic">
|
|
<summary>Gets a value indicating whether the typeface claims to be slanted.</summary>
|
|
<value />
|
|
<remarks>
|
|
<format type="text/markdown"><![CDATA[
|
|
## Remarks
|
|
|
|
A typeface is understood to be italic when it has a slant of either
|
|
<xref:SkiaSharp.SKFontStyleSlant.Italic> or
|
|
<xref:SkiaSharp.SKFontStyleSlant.Oblique>.
|
|
]]></format>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.OpenStream">
|
|
<summary>Returns a stream for the contents of the font data.</summary>
|
|
<returns>Returns a stream for the contents of the font data, or <see langword="null" /> on failure.</returns>
|
|
<remarks>The caller is responsible for deleting the stream.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.OpenStream(System.Int32@)">
|
|
<param name="ttcIndex">The TrueTypeCollection index of this typeface within the stream, or 0 if the stream is not a collection.</param>
|
|
<summary>Returns a stream for the contents of the font data.</summary>
|
|
<returns>Returns a stream for the contents of the font data, or <see langword="null" /> on failure.</returns>
|
|
<remarks>The caller is responsible for deleting the stream.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.Style">
|
|
<summary>Gets the the typeface's intrinsic style attributes.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.TableCount">
|
|
<summary>Gets the number of data tables in the typeface.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.ToFont">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.ToFont(System.Single,System.Single,System.Single)">
|
|
<param name="size">To be added.</param>
|
|
<param name="scaleX">To be added.</param>
|
|
<param name="skewX">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.TryGetTableData(System.UInt32,System.Byte[]@)">
|
|
<param name="tag">The table tag to get the data for.</param>
|
|
<param name="tableData">The contents of the table data for the specified tag.</param>
|
|
<summary>Returns the contents of the table data for the specified tag.</summary>
|
|
<returns>Returns true if the content exists, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.TryGetTableData(System.UInt32,System.Int32,System.Int32,System.IntPtr)">
|
|
<param name="tag">The table tag to get the data for.</param>
|
|
<param name="offset">The offset of the data to fetch.</param>
|
|
<param name="length">The length of data to fetch.</param>
|
|
<param name="tableData">The contents of the table data for the specified tag.</param>
|
|
<summary>Returns the contents of the table data for the specified tag.</summary>
|
|
<returns>Returns true if the content exists, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKTypeface.TryGetTableTags(System.UInt32[]@)">
|
|
<param name="tags">The table tags.</param>
|
|
<summary>Returns the list of table tags in the font.</summary>
|
|
<returns>Returns true if the tags could be fetched, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKTypeface.UnitsPerEm">
|
|
<summary>Gets the units-per-em value for this typeface, or zero if there is an error.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKTypefaceStyle">
|
|
<summary>Specifies the intrinsic style attributes of a given typeface.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTypefaceStyle.Bold">
|
|
<summary>Bold</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTypefaceStyle.BoldItalic">
|
|
<summary>Bold and Italic, convenience definition.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTypefaceStyle.Italic">
|
|
<summary>Italic</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKTypefaceStyle.Normal">
|
|
<summary>Normal</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKVertexMode">
|
|
<summary>Various mode with which to interpret triangles when invoking <see cref="M:SkiaSharp.SKCanvas.DrawVertices(SkiaSharp.SKVertexMode,SkiaSharp.SKPoint[],SkiaSharp.SKColor[],SkiaSharp.SKPaint)" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKVertexMode.TriangleFan">
|
|
<summary>The vertices are a triangle fan.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKVertexMode.Triangles">
|
|
<summary>The vertices are a triangle list.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKVertexMode.TriangleStrip">
|
|
<summary>The vertices are a triangle strip.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKVertices">
|
|
<summary>Represents an immutable set of vertex data that can be used with <see cref="M:SkiaSharp.SKCanvas.DrawVertices(SkiaSharp.SKVertices,SkiaSharp.SKBlendMode,SkiaSharp.SKPaint)" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKVertices.CreateCopy(SkiaSharp.SKVertexMode,SkiaSharp.SKPoint[],SkiaSharp.SKColor[])">
|
|
<param name="vmode">How to interpret the array of vertices.</param>
|
|
<param name="positions">The array of vertices for the mesh.</param>
|
|
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKVertices" /> instance, making a copy of the vertices and related data.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKVertices" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKVertices.CreateCopy(SkiaSharp.SKVertexMode,SkiaSharp.SKPoint[],SkiaSharp.SKPoint[],SkiaSharp.SKColor[])">
|
|
<param name="vmode">How to interpret the array of vertices.</param>
|
|
<param name="positions">The array of vertices for the mesh.</param>
|
|
<param name="texs">The coordinates in texture space (not UV space) for each vertex. May be <see langword="null" />.</param>
|
|
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKVertices" /> instance, making a copy of the vertices and related data.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKVertices" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKVertices.CreateCopy(SkiaSharp.SKVertexMode,SkiaSharp.SKPoint[],SkiaSharp.SKPoint[],SkiaSharp.SKColor[],System.UInt16[])">
|
|
<param name="vmode">How to interpret the array of vertices.</param>
|
|
<param name="positions">The array of vertices for the mesh.</param>
|
|
<param name="texs">The coordinates in texture space (not UV space) for each vertex. May be <see langword="null" />.</param>
|
|
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
|
<param name="indices">The array of indices to reference into the vertex (texture coordinates, colors) array.</param>
|
|
<summary>Creates a new <see cref="T:SkiaSharp.SKVertices" /> instance, making a copy of the vertices and related data.</summary>
|
|
<returns>Returns the new <see cref="T:SkiaSharp.SKVertices" /> instance.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKVertices.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKVertices" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKVertices" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKWebpEncoderCompression">
|
|
<summary>The various types of compression for WEBP files.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKWebpEncoderCompression.Lossless">
|
|
<summary>Compress the file without loosing data.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKWebpEncoderCompression.Lossy">
|
|
<summary>Compress the files by reducing image quality.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.SKWebpEncoderOptions">
|
|
<summary>Options to control the WEBP encoding.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKWebpEncoderOptions(SkiaSharp.SKWebpEncoderCompression,System.Single)">
|
|
<param name="compression">The compression level.</param>
|
|
<param name="quality">The quality of the encoding in the range 0.0 to 100.0.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKWebpEncoderOptions" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKWebpEncoderOptions(SkiaSharp.SKWebpEncoderCompression,System.Single,SkiaSharp.SKTransferFunctionBehavior)">
|
|
<param name="compression">The compression level.</param>
|
|
<param name="quality">The quality of the encoding in the range 0.0 to 100.0.</param>
|
|
<param name="unpremulBehavior">The unpremultiplication behavior.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKWebpEncoderOptions" />.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKWebpEncoderOptions.Compression">
|
|
<summary>Gets or sets the compression level.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKWebpEncoderOptions.Default">
|
|
<summary>Gets a new instance of <see cref="T:SkiaSharp.SKWebpEncoderOptions" /> with the values set to the defaults.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWebpEncoderOptions.Equals(SkiaSharp.SKWebpEncoderOptions)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWebpEncoderOptions.Equals(System.Object)">
|
|
<param name="obj">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWebpEncoderOptions.GetHashCode">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWebpEncoderOptions.op_Equality(SkiaSharp.SKWebpEncoderOptions,SkiaSharp.SKWebpEncoderOptions)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWebpEncoderOptions.op_Inequality(SkiaSharp.SKWebpEncoderOptions,SkiaSharp.SKWebpEncoderOptions)">
|
|
<param name="left">To be added.</param>
|
|
<param name="right">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKWebpEncoderOptions.Quality">
|
|
<summary>Gets or sets the quality of the encoding.</summary>
|
|
<value />
|
|
<remarks>
|
|
<param>If the compression is lossy, then the quality corresponds to the visual quality. Lower values are smaller, but will have reduced quality.</param>
|
|
<param>If the compression is lossless, then the quality corresponds effort put into compressing the file. Lower values are faster, but higher values have smaller files.</param>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.SKWebpEncoderOptions.UnpremulBehavior">
|
|
<summary>Gets or sets the unpremultiplication behavior if the input is premultiplied.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKWStream">
|
|
<summary>An abstraction for writing a stream of bytes, which can be backed by memory, or a file, or something else.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="P:SkiaSharp.SKWStream.BytesWritten">
|
|
<summary>Gets the number of bytes written so far.</summary>
|
|
<value />
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.Flush">
|
|
<summary>Flush the buffer to the underlying destination.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.GetSizeOfPackedUInt32(System.UInt32)">
|
|
<param name="value">The value to store.</param>
|
|
<summary>Returns the number of bytes in the stream required to store the specified value.</summary>
|
|
<returns>Returns the number of bytes required.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.NewLine">
|
|
<summary>Write a newline character to the stream, if one was not already written.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks>If the last character was a newline character, this method does nothing.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.Write(System.Byte[],System.Int32)">
|
|
<param name="buffer">The data buffer to write.</param>
|
|
<param name="size">The number of bytes from the buffer to write.</param>
|
|
<summary>Write the provided data to the stream.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.Write16(System.UInt16)">
|
|
<param name="value">The unsigned 16-bit integer to write.</param>
|
|
<summary>Write a single, unsigned 16-bit integer to the stream.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.Write32(System.UInt32)">
|
|
<param name="value">The unsigned 32-bit integer to write.</param>
|
|
<summary>Write a single, unsigned 32-bit integer to the stream.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.Write8(System.Byte)">
|
|
<param name="value">The byte to write.</param>
|
|
<summary>Write a single byte to the stream.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.WriteBigDecimalAsText(System.Int64,System.Int32)">
|
|
<param name="value">The 64-bit integer to write.</param>
|
|
<param name="digits">The number of digits (length) to use when writing.</param>
|
|
<summary>Write a single 64-bit integer to the stream as a string.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.WriteBool(System.Boolean)">
|
|
<param name="value">The boolean to write.</param>
|
|
<summary>Write a single boolean to the stream.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.WriteDecimalAsTest(System.Int32)">
|
|
<param name="value">The 32-bit integer to write.</param>
|
|
<summary>Write a 32-bit integer to the stream as a string.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.WriteHexAsText(System.UInt32,System.Int32)">
|
|
<param name="value">The unsigned, 32-bit integer to write.</param>
|
|
<param name="digits">The number of digits (length) to use when writing.</param>
|
|
<summary>Write an unsigned, 32-bit integer to the stream as a hexadecimal string.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.WritePackedUInt32(System.UInt32)">
|
|
<param name="value">The unsigned 32-bit integer to write.</param>
|
|
<summary>Write a single, unsigned 32-bit integer to the stream in the smallest space possible.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.WriteScalar(System.Single)">
|
|
<param name="value">The floating-point number to write.</param>
|
|
<summary>Write a single, floating-point number to the stream.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.WriteScalarAsText(System.Single)">
|
|
<param name="value">The floating-point number to write.</param>
|
|
<summary>Write a single, floating-point number to the stream as text.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.WriteStream(SkiaSharp.SKStream,System.Int32)">
|
|
<param name="input">The stream to write.</param>
|
|
<param name="length">The number of bytes to write.</param>
|
|
<summary>Write the contents of the specified stream to this stream.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKWStream.WriteText(System.String)">
|
|
<param name="value">The string to write.</param>
|
|
<summary>Write a string to the stream as a string.</summary>
|
|
<returns>Returns true if the write succeeded, otherwise false.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKXmlStreamWriter">
|
|
<summary>A stream-based XML writer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="C:SkiaSharp.SKXmlStreamWriter(SkiaSharp.SKWStream)">
|
|
<param name="stream">The stream to write the XML to.</param>
|
|
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKXmlStreamWriter" /> which writes to the provided stream.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.SKXmlStreamWriter.Dispose(System.Boolean)">
|
|
<param name="disposing">
|
|
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKXmlStreamWriter" /> and optionally releases the managed resources.</summary>
|
|
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKXmlStreamWriter" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.SKXmlStreamWriter.DisposeNative">
|
|
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKXmlWriter">
|
|
<summary>An abstract, XML writer.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.SKZeroInitialized">
|
|
<summary>Whether or not the memory passed to <see cref="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKCodecOptions)" /> (or one of the overloads that accepts a <see cref="T:SkiaSharp.SKCodecOptions" />) is zero initialized</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="F:SkiaSharp.SKZeroInitialized.No">
|
|
<summary>The memory passed has not been initialized to zero, so the codec must write all zeros to memory.</summary>
|
|
</member>
|
|
<member name="F:SkiaSharp.SKZeroInitialized.Yes">
|
|
<summary>The memory passed is zero initialized, so the codec may take advantage of this by skipping writing zeroes.</summary>
|
|
</member>
|
|
<member name="T:SkiaSharp.StringUtilities">
|
|
<summary>Various utility methods for when working with strings and text.</summary>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.StringUtilities.GetEncodedText(System.ReadOnlySpan{System.Char},SkiaSharp.SKTextEncoding)">
|
|
<param name="text">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.StringUtilities.GetEncodedText(System.String,SkiaSharp.SKEncoding)">
|
|
<param name="text">The text to encode.</param>
|
|
<param name="encoding">The encoding to use.</param>
|
|
<summary>Encodes the specified string using the encoding as a byte array.</summary>
|
|
<returns>Returns the encoded text as a byte array.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.StringUtilities.GetEncodedText(System.String,SkiaSharp.SKTextEncoding)">
|
|
<param name="text">The text to encode.</param>
|
|
<param name="encoding">The encoding to use.</param>
|
|
<summary>Encodes the specified string using the encoding as a byte array.</summary>
|
|
<returns>Returns the encoded text as a byte array.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.StringUtilities.GetString(System.Byte[],SkiaSharp.SKTextEncoding)">
|
|
<param name="data">The bytes representing text.</param>
|
|
<param name="encoding">The encoding to use.</param>
|
|
<summary>Decodes the specified bytes as a string.</summary>
|
|
<returns>Returns the decoded text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.StringUtilities.GetString(System.ReadOnlySpan{System.Byte},SkiaSharp.SKTextEncoding)">
|
|
<param name="data">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.StringUtilities.GetString(System.IntPtr,System.Int32,SkiaSharp.SKTextEncoding)">
|
|
<param name="data">The pointer to the bytes representing text.</param>
|
|
<param name="dataLength">The number of bytes to decode.</param>
|
|
<param name="encoding">The encoding to use.</param>
|
|
<summary>Decodes the specified bytes as a string.</summary>
|
|
<returns>Returns the decoded text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.StringUtilities.GetString(System.Byte[],System.Int32,System.Int32,SkiaSharp.SKTextEncoding)">
|
|
<param name="data">The bytes representing text.</param>
|
|
<param name="index">The index to start decoding.</param>
|
|
<param name="count">The number of bytes to decode.</param>
|
|
<param name="encoding">The encoding to use.</param>
|
|
<summary>Encodes the specified string using the encoding as a byte array.</summary>
|
|
<returns>Returns the decoded text.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="M:SkiaSharp.StringUtilities.GetString(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,SkiaSharp.SKTextEncoding)">
|
|
<param name="data">To be added.</param>
|
|
<param name="index">To be added.</param>
|
|
<param name="count">To be added.</param>
|
|
<param name="encoding">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.StringUtilities.GetUnicodeCharacterCode(System.String,SkiaSharp.SKTextEncoding)">
|
|
<param name="character">The character to get the Unicode character code.</param>
|
|
<param name="encoding">The encoding of the string.</param>
|
|
<summary>Returns the Unicode character code for the specified character.</summary>
|
|
<returns>Returns the Unicode character code.</returns>
|
|
<remarks />
|
|
</member>
|
|
<member name="T:SkiaSharp.Internals.IPlatformLock">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.Internals.IPlatformLock.EnterReadLock">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.Internals.IPlatformLock.EnterUpgradeableReadLock">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.Internals.IPlatformLock.EnterWriteLock">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.Internals.IPlatformLock.ExitReadLock">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.Internals.IPlatformLock.ExitUpgradeableReadLock">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.Internals.IPlatformLock.ExitWriteLock">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.Internals.PlatformConfiguration">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.Internals.PlatformConfiguration.Is64Bit">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.Internals.PlatformConfiguration.IsArm">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.Internals.PlatformConfiguration.IsGlibc">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.Internals.PlatformConfiguration.IsLinux">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.Internals.PlatformConfiguration.IsMac">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.Internals.PlatformConfiguration.IsUnix">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.Internals.PlatformConfiguration.IsWindows">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.Internals.PlatformConfiguration.LinuxFlavor">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="T:SkiaSharp.Internals.PlatformLock">
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.Internals.PlatformLock.Create">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="M:SkiaSharp.Internals.PlatformLock.DefaultFactory">
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
<member name="P:SkiaSharp.Internals.PlatformLock.Factory">
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</member>
|
|
</members>
|
|
</doc>
|