From b93577c130ac329b2f948d87b06e92294f939069 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 20 Aug 2026 08:29:57 +0000 Subject: [PATCH] Fill and review API documentation Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- SkiaSharpAPI/SkiaSharp/GRContext.xml | 84 ++- SkiaSharpAPI/SkiaSharp/GRVkExtensions.xml | 27 +- SkiaSharpAPI/SkiaSharp/SKGraphiteBackend.xml | 86 +++ .../SkiaSharp/SKGraphiteBackendTexture.xml | 180 ++++++ SkiaSharpAPI/SkiaSharp/SKGraphiteContext.xml | 602 ++++++++++++++++++ .../SkiaSharp/SKGraphiteContextOptions.xml | 274 ++++++++ .../SKGraphiteDawnBackendContext.xml | 143 +++++ .../SKGraphiteDawnBackendContextInit.xml | 249 ++++++++ .../SKGraphiteFindOrCreateImageDelegate.xml | 29 + .../SkiaSharp/SKGraphiteImageCache.xml | 94 +++ .../SKGraphiteInsertRecordingInfo.xml | 271 ++++++++ .../SkiaSharp/SKGraphiteInsertStatus.xml | 120 ++++ .../SkiaSharp/SKGraphiteMtlBackendContext.xml | 125 ++++ .../SKGraphiteMtlBackendContextInit.xml | 202 ++++++ SkiaSharpAPI/SkiaSharp/SKGraphiteRecorder.xml | 147 +++++ .../SkiaSharp/SKGraphiteRecording.xml | 45 ++ .../SkiaSharp/SKGraphiteReleaseDelegate.xml | 20 + .../SkiaSharp/SKGraphiteSubmitInfo.xml | 227 +++++++ .../SkiaSharp/SKGraphiteTextureInfo.xml | 141 ++++ .../SkiaSharp/SKGraphiteVkBackendContext.xml | 230 +++++++ ...KGraphiteVkGetProcedureAddressDelegate.xml | 28 + .../SkiaSharp/SKGraphiteVkTextureInfo.xml | 341 ++++++++++ SkiaSharpAPI/SkiaSharp/SKImage.xml | 391 +++++++++--- .../SkiaSharp/SKImageReadPixelsResult.xml | 197 ++++++ .../SkiaSharp/SKImageRescaleGamma.xml | 52 ++ SkiaSharpAPI/SkiaSharp/SKImageRescaleMode.xml | 86 +++ SkiaSharpAPI/SkiaSharp/SKSurface.xml | 414 ++++++++++-- 27 files changed, 4597 insertions(+), 208 deletions(-) create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteBackend.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteBackendTexture.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteContext.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteContextOptions.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteDawnBackendContext.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteDawnBackendContextInit.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteFindOrCreateImageDelegate.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteImageCache.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteInsertRecordingInfo.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteInsertStatus.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteMtlBackendContext.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteMtlBackendContextInit.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteRecorder.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteRecording.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteReleaseDelegate.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteSubmitInfo.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteTextureInfo.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteVkBackendContext.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteVkGetProcedureAddressDelegate.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKGraphiteVkTextureInfo.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKImageReadPixelsResult.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKImageRescaleGamma.xml create mode 100644 SkiaSharpAPI/SkiaSharp/SKImageRescaleMode.xml diff --git a/SkiaSharpAPI/SkiaSharp/GRContext.xml b/SkiaSharpAPI/SkiaSharp/GRContext.xml index 9a251e7e..6377ef6b 100644 --- a/SkiaSharpAPI/SkiaSharp/GRContext.xml +++ b/SkiaSharpAPI/SkiaSharp/GRContext.xml @@ -4,7 +4,7 @@ SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRRecordingContext @@ -22,7 +22,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -43,7 +43,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRBackend @@ -54,6 +54,24 @@ + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Checks for and processes any completed asynchronous GPU work, invoking pending callbacks. + + + @@ -61,7 +79,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -83,7 +101,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -107,7 +125,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -126,7 +144,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -148,7 +166,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -170,7 +188,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -194,7 +212,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -216,7 +234,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -240,7 +258,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -262,7 +280,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRContext @@ -286,7 +304,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -308,7 +326,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -326,7 +344,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -347,7 +365,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -365,7 +383,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -386,7 +404,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -407,7 +425,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -432,7 +450,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Int32 @@ -454,7 +472,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Int64 @@ -473,7 +491,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -496,7 +514,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -515,7 +533,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -533,7 +551,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -555,7 +573,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -579,7 +597,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -600,7 +618,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -621,7 +639,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -642,7 +660,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -663,7 +681,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -684,7 +702,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void diff --git a/SkiaSharpAPI/SkiaSharp/GRVkExtensions.xml b/SkiaSharpAPI/SkiaSharp/GRVkExtensions.xml index 0197a697..c3b7251e 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkExtensions.xml @@ -4,7 +4,7 @@ SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKObject @@ -15,6 +15,21 @@ + + + + + Constructor + + SkiaSharp + 4.152.0.0 + + + + Initializes a new instance of the class. + + + @@ -22,7 +37,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRVkExtensions @@ -52,7 +67,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -70,7 +85,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -93,7 +108,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -118,7 +133,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteBackend.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteBackend.xml new file mode 100644 index 00000000..67fdfeae --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteBackend.xml @@ -0,0 +1,86 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Enum + + + Specifies the graphics backend that drives a Graphite context. + + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackend + + 0 + + The Dawn (WebGPU) backend. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackend + + 1 + + The Apple Metal backend. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackend + + -1 + + An unknown or unsupported backend. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackend + + 2 + + The Vulkan backend. + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteBackendTexture.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteBackendTexture.xml new file mode 100644 index 00000000..ee37c399 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteBackendTexture.xml @@ -0,0 +1,180 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKObject + + + + Wraps an existing platform GPU texture so that it can be used as a Graphite render target or sampling source. + + , , or ). The caller retains ownership of the underlying platform texture; disposing this wrapper does not destroy it. + +This type wraps a native Skia resource and implements `IDisposable`. Dispose it when it is no longer needed. +]]> + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackend + + + Gets the graphics backend that this texture belongs to. + One of the enumeration values that indicates the backend. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackendTexture + + + + + + A handle to the WebGPU texture to wrap. + Wraps an existing Dawn (WebGPU) texture as a Graphite backend texture. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackendTexture + + + + + + + + The width of the texture, in pixels. + The height of the texture, in pixels. + A handle to the Metal texture to wrap. + Wraps an existing Metal texture as a Graphite backend texture. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackendTexture + + + + + + + + + + + The width of the texture, in pixels. + The height of the texture, in pixels. + The Vulkan texture descriptor. + The current Vulkan image layout of the texture. + The index of the Vulkan queue family that owns the image. + A handle to the Vulkan image to wrap. + Wraps an existing Vulkan image as a Graphite backend texture. + A new , or if it could not be created. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKSizeI + + + Gets the dimensions of the texture, in pixels. + The width and height of the texture. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases the native resources used by the backend texture wrapper. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + Gets a value indicating whether the wrapper references a valid texture. + + if the backend texture is valid; otherwise, . + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteContext.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteContext.xml new file mode 100644 index 00000000..983a3f28 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteContext.xml @@ -0,0 +1,602 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKObject + + + + Represents a Graphite GPU context that owns backend resources and executes recordings against a Dawn, Metal, or Vulkan backend. + + , , or . Create one or more recorders with , draw into Graphite-backed surfaces, snap the work into recordings, insert them into the context, and submit. + +This type wraps a native Skia resource and implements `IDisposable`. Dispose it after all its recorders and surfaces have been disposed. + +## Examples + +```csharp +using var context = SKGraphiteContext.CreateMetal(backendContext); +using var recorder = context.CreateRecorder(); + +var info = new SKImageInfo(256, 256); +using var surface = SKSurface.Create(recorder, info); +surface.Canvas.Clear(SKColors.CornflowerBlue); + +using var recording = recorder.Snap(); +context.InsertRecording(recording); +context.Submit(); +``` +]]> + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackend + + + Gets the graphics backend that this context uses. + One of the enumeration values that indicates the backend. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Checks for and processes any completed asynchronous GPU work, invoking pending callbacks. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteContext + + + + + + The Dawn backend context that supplies the instance, device, and queue. + Creates a Dawn (WebGPU) backed Graphite context using the default options. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteContext + + + + + + + The Dawn backend context that supplies the instance, device, and queue. + The options that configure the context. + Creates a Dawn (WebGPU) backed Graphite context using the specified options. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteContext + + + + + + The Metal backend context that supplies the device and queue. + Creates a Metal-backed Graphite context using the default options. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteContext + + + + + + + The Metal backend context that supplies the device and queue. + The options that configure the context. + Creates a Metal-backed Graphite context using the specified options. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteRecorder + + + + + + The GPU memory budget for the recorder, in bytes, or -1 to use the Skia default. + Creates a new recorder owned by this context. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteRecorder + + + + + + + + The GPU memory budget for the recorder, in bytes, or -1 to use the Skia default. + The callback that finds or uploads a Graphite-backed image for a source image, or for none. + An optional cleanup action invoked before the recorder is destroyed, or for none. + Creates a new recorder owned by this context, using the specified callback to provide Graphite-backed images. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteContext + + + + + + The Vulkan backend context that supplies the device and function loader. + Creates a Vulkan-backed Graphite context using the default options. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteContext + + + + + + + The Vulkan backend context that supplies the device and function loader. + The options that configure the context. + Creates a Vulkan-backed Graphite context using the specified options. + A new , or if it could not be created. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Int64 + + + Gets the number of bytes of GPU memory currently used by budgeted resources. + The current budgeted GPU memory usage, in bytes. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + The backend texture to delete. + Deletes a backend texture that was created by this context. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases the native resources used by the context. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Frees GPU resources held by the context's resource cache. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteInsertStatus + + + + + + The parameters that describe the recording to insert and where to place it. + Inserts a recording into the context using the specified insertion parameters. + One of the enumeration values that indicates the result of the insertion. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteInsertStatus + + + + + + The recording to insert. + Inserts a recording into the context so its commands are executed on the next submit. + One of the enumeration values that indicates the result of the insertion. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + One of the enumeration values that specifies the backend to check. + Determines whether the specified Graphite backend is available in this build of SkiaSharp. + + if the backend is available; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + Gets a value indicating whether the underlying GPU device has been lost. + + if the device has been lost; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Int64 + + + Gets or sets the maximum number of bytes of GPU memory the resource cache may use. + The maximum budgeted GPU memory, in bytes. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Int32 + + + Gets the maximum texture dimension supported by the context's backend, in pixels. + The maximum texture size, in pixels. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + The minimum time a resource must have been unused before it is purged. + Purges GPU resources that have not been used for at least the specified duration. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + + + + The surface to read pixels from. + The image info describing the desired size and format of the result. + The rectangle of the surface to read, in pixels. + The callback invoked with the read result, which is valid only for the duration of the call. + Asynchronously reads pixels from the specified surface into a result delivered to a callback, using nearest sampling. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + + + + + + The surface to read pixels from. + The image info describing the desired size and format of the result. + The rectangle of the surface to read, in pixels. + One of the enumeration values that specifies the gamma space used for rescaling. + One of the enumeration values that specifies the sampling algorithm used for rescaling. + The callback invoked with the read result, which is valid only for the duration of the call. + Asynchronously reads and rescales pixels from the specified surface into a result delivered to a callback. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + Submits all inserted recordings to the GPU without waiting for completion. + + if the work was submitted successfully; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + The options that control how the work is submitted. + Submits all inserted recordings to the GPU using the specified submission options. + + if the work was submitted successfully; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + Gets a value indicating whether the context supports protected content. + + if protected content is supported; otherwise, . + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteContextOptions.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteContextOptions.xml new file mode 100644 index 00000000..5ce63732 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteContextOptions.xml @@ -0,0 +1,274 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.ValueType + + + + System.IEquatable<SkiaSharp.SKGraphiteContextOptions> + + + + Specifies configuration options used when creating a . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether driver correctness workarounds are disabled. + + to disable driver correctness workarounds; otherwise, . + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The context options to compare with the current context options. + Determines whether the specified context options is equal to the current context options. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with the current context options. + Determines whether the specified object is equal to the current context options. + + if the specified object is equal to the current value; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + + Returns the hash code for this context options. + A hash code for the current value. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int64 + + + Gets or sets the maximum number of bytes of GPU memory the context may use for its resource cache. + The GPU resource cache budget, in bytes. A negative value uses the Skia default budget. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + Gets or sets the sample count used for internal multisampled rendering. + The internal multisample count. Must be 0 to use the Skia default, or one of 1, 2, 4, 8, or 16. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two context options values are equal. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two context options values are not equal. + + if the two values are not equal; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether recordings must be inserted in the order they were snapped. + + if recordings must be inserted in order; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether Skia labels the backend objects it creates, which aids debugging. + + to label backend objects; otherwise, . + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteDawnBackendContext.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteDawnBackendContext.xml new file mode 100644 index 00000000..64fdb82e --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteDawnBackendContext.xml @@ -0,0 +1,143 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Object + + + + System.IDisposable + + + + Supplies the Dawn (WebGPU) instance, device, and queue used to create a Dawn-backed . + + , , and handles, then pass this object to . You can dispose it as soon as the context has been created. + +On non-yielding environments such as the browser (WASM), the Dawn event loop cannot be pumped from inside a managed call frame, so synchronous submits are rejected; drive readbacks with instead. +]]> + + + + + + + + Constructor + + SkiaSharp + 4.152.0.0 + + + + Initializes a new instance of the class. + + + + + + + + Method + + M:System.IDisposable.Dispose + + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases the resources used by the current instance of the class. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the and optionally releases the managed resources. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.IntPtr + + + Gets or sets the handle to the WebGPU device. + A handle to the WebGPU device. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.IntPtr + + + Gets or sets the handle to the WebGPU instance. + A handle to the WebGPU instance. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.IntPtr + + + Gets or sets the handle to the WebGPU queue. + A handle to the WebGPU queue. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteDawnBackendContextInit.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteDawnBackendContextInit.xml new file mode 100644 index 00000000..5e9f0820 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteDawnBackendContextInit.xml @@ -0,0 +1,249 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.ValueType + + + + System.IEquatable<SkiaSharp.SKGraphiteDawnBackendContextInit> + + + + Contains the native Dawn (WebGPU) handles used to initialize a Dawn-backed Graphite context. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Void* + + + Gets or sets the pointer to the WebGPU device. + A pointer to the WebGPU device. + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The Dawn backend initialization data to compare with the current Dawn backend initialization data. + Determines whether the specified Dawn backend initialization data is equal to the current Dawn backend initialization data. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with the current Dawn backend initialization data. + Determines whether the specified object is equal to the current Dawn backend initialization data. + + if the specified object is equal to the current value; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + + Returns the hash code for this Dawn backend initialization data. + A hash code for the current value. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Void* + + + Gets or sets the pointer to the WebGPU instance. + A pointer to the WebGPU instance. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether the environment cannot yield to pump the Dawn event loop. + + if the environment is non-yielding; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two Dawn backend initialization data values are equal. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two Dawn backend initialization data values are not equal. + + if the two values are not equal; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Void* + + + Gets or sets the pointer to the WebGPU queue. + A pointer to the WebGPU queue. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteFindOrCreateImageDelegate.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteFindOrCreateImageDelegate.xml new file mode 100644 index 00000000..1df54569 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteFindOrCreateImageDelegate.xml @@ -0,0 +1,29 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Delegate + + + + + + + + SkiaSharp.SKImage + + + The recorder that the returned image is created for. + The source image to find or upload. + + to create the texture with mipmaps; otherwise, . + Represents the method that returns a Graphite-backed image for the specified source image, uploading it to the recorder if it has not been cached yet. + A Graphite-backed image for the source image, or if one could not be created. + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteImageCache.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteImageCache.xml new file mode 100644 index 00000000..255bcfbd --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteImageCache.xml @@ -0,0 +1,94 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Object + + + + System.IDisposable + + + + Provides a bounded, least-recently-used cache of Graphite-backed textures keyed by source image, for reuse across recordings. + + so that repeatedly drawn images are uploaded to the GPU only once. The cache holds a reference to each cached texture until the entry is evicted or the cache is disposed. + +This type implements `IDisposable`. Dispose it while its owning recorder is still alive so the cached textures can be released safely. +]]> + + + + + + + + Constructor + + SkiaSharp + 4.152.0.0 + + + + Initializes a new instance of the class. + + + + + + + + Method + + M:System.IDisposable.Dispose + + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases all cached textures held by the cache. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImage + + + + + + + + The recorder to upload the image to on a cache miss. + The source image to find or upload. + + to create the texture with mipmaps; otherwise, . + Returns the cached Graphite-backed texture for the specified image, uploading and caching it on the recorder if it is not already present. + A Graphite-backed image, or if the image could not be uploaded. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteInsertRecordingInfo.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteInsertRecordingInfo.xml new file mode 100644 index 00000000..46b6f730 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteInsertRecordingInfo.xml @@ -0,0 +1,271 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.ValueType + + + + System.IEquatable<SkiaSharp.SKGraphiteInsertRecordingInfo> + + + + Specifies a recording to insert into a along with the target surface and placement. + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The recording insertion info to compare with the current recording insertion info. + Determines whether the specified recording insertion info is equal to the current recording insertion info. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with the current recording insertion info. + Determines whether the specified object is equal to the current recording insertion info. + + if the specified object is equal to the current value; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + + Returns the hash code for this recording insertion info. + A hash code for the current value. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two recording insertion info values are equal. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two recording insertion info values are not equal. + + if the two values are not equal; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.IntPtr + + + Gets or sets the handle to the recording to insert. + A handle to the recording. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + SkiaSharp.SKRectI + + + Gets or sets the clip rectangle applied to the recording on the target surface. + The clip rectangle. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.IntPtr + + + Gets or sets the handle to the surface that the recording targets. + A handle to the target surface, or to use the surface the recording was made for. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + Gets or sets the horizontal translation applied to the recording on the target surface. + The horizontal translation, in pixels. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + Gets or sets the vertical translation applied to the recording on the target surface. + The vertical translation, in pixels. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteInsertStatus.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteInsertStatus.xml new file mode 100644 index 00000000..d3e619c1 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteInsertStatus.xml @@ -0,0 +1,120 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Enum + + + Describes the result of inserting a recording into a Graphite context. + + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteInsertStatus + + 3 + + The commands from the recording could not be added to the backend command buffer. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteInsertStatus + + 4 + + One or more asynchronous shader compilations required by the recording failed. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteInsertStatus + + 1 + + The recording was not valid and could not be inserted. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteInsertStatus + + 5 + + The recording was inserted out of the order required when ordered recordings are enforced. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteInsertStatus + + 2 + + A promise image referenced by the recording could not be instantiated. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteInsertStatus + + 0 + + The recording was inserted successfully. + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteMtlBackendContext.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteMtlBackendContext.xml new file mode 100644 index 00000000..9b9d5fea --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteMtlBackendContext.xml @@ -0,0 +1,125 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Object + + + + System.IDisposable + + + + Supplies the Metal device and command queue used to create a Metal-backed . + + and handles, then pass this object to . You can dispose it as soon as the context has been created. + +On Apple platforms you can also assign the strongly typed `Device` and `Queue` properties instead of raw handles. +]]> + + + + + + + + Constructor + + SkiaSharp + 4.152.0.0 + + + + Initializes a new instance of the class. + + + + + + + + Method + + M:System.IDisposable.Dispose + + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases the resources used by the current instance of the class. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the and optionally releases the managed resources. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.IntPtr + + + Gets or sets the handle to the Metal device. + A handle to the Metal device. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.IntPtr + + + Gets or sets the handle to the Metal command queue. + A handle to the Metal command queue. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteMtlBackendContextInit.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteMtlBackendContextInit.xml new file mode 100644 index 00000000..5f7a9be5 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteMtlBackendContextInit.xml @@ -0,0 +1,202 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.ValueType + + + + System.IEquatable<SkiaSharp.SKGraphiteMtlBackendContextInit> + + + + Contains the native Metal handles used to initialize a Metal-backed Graphite context. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Void* + + + Gets or sets the pointer to the Metal device. + A pointer to the Metal device. + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The Metal backend initialization data to compare with the current Metal backend initialization data. + Determines whether the specified Metal backend initialization data is equal to the current Metal backend initialization data. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with the current Metal backend initialization data. + Determines whether the specified object is equal to the current Metal backend initialization data. + + if the specified object is equal to the current value; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + + Returns the hash code for this Metal backend initialization data. + A hash code for the current value. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two Metal backend initialization data values are equal. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two Metal backend initialization data values are not equal. + + if the two values are not equal; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Void* + + + Gets or sets the pointer to the Metal command queue. + A pointer to the Metal command queue. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteRecorder.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteRecorder.xml new file mode 100644 index 00000000..bfa219cb --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteRecorder.xml @@ -0,0 +1,147 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKObject + + + + Records drawing commands issued against Graphite-backed surfaces and snapshots them into recordings for insertion into a . + + . Draw into Graphite-backed surfaces created for the recorder, call to capture the work as a , then insert and submit the recording through the context. + +A recorder is not thread-safe; use one recorder per thread. This type wraps a native Skia resource and implements `IDisposable`. +]]> + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackend + + + Gets the graphics backend that this recorder uses. + One of the enumeration values that indicates the backend. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackendTexture + + + + + + + + The width of the texture, in pixels. + The height of the texture, in pixels. + The texture descriptor. + Creates a new backend texture that is owned by the recorder's context. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + The backend texture to delete. + Deletes a backend texture that was created by this recorder. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases the native resources used by the recorder. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Int32 + + + Gets the maximum texture dimension supported by the recorder's backend, in pixels. + The maximum texture size, in pixels. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteRecording + + + + Captures the commands recorded so far into a new recording and resets the recorder for further recording. + A new , or if there was nothing to record. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteRecording.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteRecording.xml new file mode 100644 index 00000000..ca136923 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteRecording.xml @@ -0,0 +1,45 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKObject + + + + Represents a set of drawing commands that have been captured from a and can be inserted into a for execution. + + . Insert it into a context with and then submit the context to execute the captured work on the GPU. + +This type wraps a native Skia resource and implements `IDisposable`. Dispose it once it has been inserted and is no longer needed. +]]> + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases the native resources used by the recording. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteReleaseDelegate.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteReleaseDelegate.xml new file mode 100644 index 00000000..8286e0e0 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteReleaseDelegate.xml @@ -0,0 +1,20 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Delegate + + + + System.Void + + + Represents the method that is called when Skia is finished using a wrapped Graphite backend texture and the caller may release the underlying resource. + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteSubmitInfo.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteSubmitInfo.xml new file mode 100644 index 00000000..c7efd136 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteSubmitInfo.xml @@ -0,0 +1,227 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.ValueType + + + + System.IEquatable<SkiaSharp.SKGraphiteSubmitInfo> + + + + Specifies options that control how queued work is submitted to the GPU by a . + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The submission info to compare with the current submission info. + Determines whether the specified submission info is equal to the current submission info. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with the current submission info. + Determines whether the specified object is equal to the current submission info. + + if the specified object is equal to the current value; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt64 + + + Gets or sets the identifier of the frame associated with this submission. + The frame identifier. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + + Returns the hash code for this submission info. + A hash code for the current value. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether the submission marks a frame boundary. + + to mark a frame boundary; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two submission info values are equal. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two submission info values are not equal. + + if the two values are not equal; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether the submit call blocks until the GPU has finished the submitted work. + + to wait for the GPU to finish; otherwise, . + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteTextureInfo.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteTextureInfo.xml new file mode 100644 index 00000000..c7a6b8cb --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteTextureInfo.xml @@ -0,0 +1,141 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKObject + + + + Describes the format and sampling properties of a Graphite backend texture in a backend-agnostic way. + + , and pass it to . + +This type wraps a native Skia resource and implements `IDisposable`. Dispose it when it is no longer needed. +]]> + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteBackend + + + Gets the graphics backend that this texture info is for. + One of the enumeration values that indicates the backend. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteTextureInfo + + + + + + The Vulkan texture descriptor to wrap. + Creates a texture info from a Vulkan texture descriptor. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases the native resources used by the texture info. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + Gets a value indicating whether the texture info describes a valid texture. + + if the texture info is valid; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + Gets a value indicating whether the texture has mipmaps. + + if the texture has mipmaps; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Int32 + + + Gets the number of samples per pixel of the texture. + The sample count. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteVkBackendContext.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteVkBackendContext.xml new file mode 100644 index 00000000..2f82e75a --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteVkBackendContext.xml @@ -0,0 +1,230 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Object + + + + System.IDisposable + + + + Supplies the Vulkan instance, devices, queue, and function loader used to create a Vulkan-backed . + + loader, then pass this object to . Ownership of the delegate that keeps the function loader alive is transferred to the context, so you can dispose this object as soon as the context has been created. + +This type implements `IDisposable`. +]]> + + + + + + + + Constructor + + SkiaSharp + 4.152.0.0 + + + + Initializes a new instance of the class. + + + + + + + + Method + + M:System.IDisposable.Dispose + + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases the resources used by the current instance of the class. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Releases the unmanaged resources used by the before it is reclaimed by garbage collection. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKGraphiteVkGetProcedureAddressDelegate + + + Gets or sets the delegate that resolves Vulkan function addresses by name. + The Vulkan function loader delegate, or if none is set. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.UInt32 + + + Gets or sets the index of the Vulkan queue family used for graphics operations. + The graphics queue family index. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.UInt32 + + + Gets or sets the maximum Vulkan API version that Skia may use. + The packed maximum Vulkan API version, or 0 to let Skia choose. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + Gets or sets a value indicating whether the context uses Vulkan protected content. + + if the context uses protected content; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.IntPtr + + + Gets or sets the handle to the Vulkan logical device. + A handle to the Vulkan logical device. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.IntPtr + + + Gets or sets the handle to the Vulkan instance. + A handle to the Vulkan instance. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.IntPtr + + + Gets or sets the handle to the Vulkan physical device. + A handle to the Vulkan physical device. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.IntPtr + + + Gets or sets the handle to the Vulkan queue. + A handle to the Vulkan queue. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteVkGetProcedureAddressDelegate.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteVkGetProcedureAddressDelegate.xml new file mode 100644 index 00000000..cd2436c2 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteVkGetProcedureAddressDelegate.xml @@ -0,0 +1,28 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Delegate + + + + + + + + System.IntPtr + + + The name of the Vulkan function to resolve. + The Vulkan instance handle to resolve the function against, or when resolving a global or device-level function. + The Vulkan device handle to resolve the function against, or when resolving a global or instance-level function. + Represents the method that resolves the address of a Vulkan function by name. + A pointer to the resolved Vulkan function, or if the function could not be found. + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKGraphiteVkTextureInfo.xml b/SkiaSharpAPI/SkiaSharp/SKGraphiteVkTextureInfo.xml new file mode 100644 index 00000000..ded59e51 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKGraphiteVkTextureInfo.xml @@ -0,0 +1,341 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.ValueType + + + + System.IEquatable<SkiaSharp.SKGraphiteVkTextureInfo> + + + + Describes the Vulkan-specific format and usage of a texture for use with Graphite. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the Vulkan image aspect mask. + A bitwise combination of Vulkan VkImageAspectFlags values. + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The Vulkan texture info to compare with the current Vulkan texture info. + Determines whether the specified Vulkan texture info is equal to the current Vulkan texture info. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with the current Vulkan texture info. + Determines whether the specified object is equal to the current Vulkan texture info. + + if the specified object is equal to the current value; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the Vulkan image creation flags. + A bitwise combination of Vulkan VkImageCreateFlags values. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + Gets or sets the Vulkan image format. + The Vulkan VkFormat value. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + + Returns the hash code for this Vulkan texture info. + A hash code for the current value. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + Gets or sets the Vulkan image tiling arrangement. + The Vulkan VkImageTiling value. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the Vulkan image usage flags. + A bitwise combination of Vulkan VkImageUsageFlags values. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether the texture has mipmaps. + + if the texture has mipmaps; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two Vulkan texture info values are equal. + + if the two values are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Indicates whether two Vulkan texture info values are not equal. + + if the two values are not equal; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + Gets or sets the number of samples per pixel. + The sample count. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + Gets or sets the Vulkan image sharing mode. + The Vulkan VkSharingMode value. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKImage.xml b/SkiaSharpAPI/SkiaSharp/SKImage.xml index 06c80e9e..5fb3e3dd 100644 --- a/SkiaSharpAPI/SkiaSharp/SKImage.xml +++ b/SkiaSharpAPI/SkiaSharp/SKImage.xml @@ -4,7 +4,7 @@ SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKObject @@ -28,7 +28,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKAlphaType @@ -46,7 +46,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -76,7 +76,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -106,7 +106,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -138,7 +138,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -170,7 +170,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKColorSpace @@ -188,7 +188,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKColorType @@ -206,7 +206,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -228,7 +228,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -250,7 +250,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKData @@ -269,7 +269,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKData @@ -293,7 +293,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKData @@ -311,7 +311,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -337,7 +337,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -363,7 +363,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -391,7 +391,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -419,7 +419,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -449,7 +449,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -479,7 +479,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -511,7 +511,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -543,7 +543,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -565,7 +565,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -587,7 +587,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -609,7 +609,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -631,7 +631,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -653,7 +653,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -675,7 +675,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -697,7 +697,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -721,7 +721,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -745,7 +745,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -771,7 +771,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -797,7 +797,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -825,7 +825,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -847,7 +847,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -871,7 +871,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -895,7 +895,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -919,7 +919,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -943,7 +943,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -967,7 +967,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -993,7 +993,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1019,7 +1019,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1045,7 +1045,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1071,7 +1071,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1097,7 +1097,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1119,7 +1119,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1143,7 +1143,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1167,7 +1167,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1191,7 +1191,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1217,7 +1217,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1243,7 +1243,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1269,7 +1269,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1295,7 +1295,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1321,7 +1321,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1349,7 +1349,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1370,6 +1370,34 @@ + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImage + + + + + + + + + The recorder that the image is created for. + The backend texture to sample from. + One of the enumeration values that specifies the color type of the texture. + One of the enumeration values that specifies the alpha type of the texture. + Creates an image that samples from an existing Graphite backend texture. + A new , or if it could not be created. + + + @@ -1377,7 +1405,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1407,7 +1435,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1430,6 +1458,36 @@ + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImage + + + + + + + + + + The recorder that the image is created for. + The backend texture to sample from. + One of the enumeration values that specifies the color type of the texture. + One of the enumeration values that specifies the alpha type of the texture. + The color space of the texture, or to use no color space. + Creates an image that samples from an existing Graphite backend texture, using the specified color space. + A new , or if it could not be created. + + + @@ -1437,7 +1495,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1469,7 +1527,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1494,6 +1552,38 @@ + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImage + + + + + + + + + + + The recorder that the image is created for. + The backend texture to sample from. + One of the enumeration values that specifies the color type of the texture. + One of the enumeration values that specifies the alpha type of the texture. + The color space of the texture, or to use no color space. + The callback invoked when Skia is finished using the texture, or for none. + Creates an image that samples from an existing Graphite backend texture, invoking a callback when Skia no longer needs the texture. + A new , or if it could not be created. + + + @@ -1501,7 +1591,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1535,7 +1625,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1569,7 +1659,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1605,7 +1695,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1641,7 +1731,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Int32 @@ -1659,7 +1749,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImageInfo @@ -1677,7 +1767,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1696,7 +1786,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1715,7 +1805,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1734,7 +1824,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1756,7 +1846,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1778,7 +1868,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKPixmap @@ -1797,7 +1887,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1819,7 +1909,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1841,7 +1931,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1865,7 +1955,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1891,7 +1981,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1917,7 +2007,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1945,7 +2035,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1975,7 +2065,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -2000,6 +2090,60 @@ This method may return if the source rectangle [, , dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types. + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + + + The image info describing the desired size and format of the result. + The rectangle of the image to read, in pixels. + The callback invoked with the read result, which is valid only for the duration of the call. + Asynchronously reads pixels from the image into a result delivered to a callback, using nearest sampling. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + + + + + The image info describing the desired size and format of the result. + The rectangle of the image to read, in pixels. + One of the enumeration values that specifies the gamma space used for rescaling. + One of the enumeration values that specifies the sampling algorithm used for rescaling. + The callback invoked with the read result, which is valid only for the duration of the call. + Asynchronously reads and rescales pixels from the image into a result delivered to a callback. + + + @@ -2007,7 +2151,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -2031,7 +2175,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -2057,7 +2201,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -2079,7 +2223,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -2103,7 +2247,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -2122,7 +2266,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -2144,7 +2288,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2163,7 +2307,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2187,7 +2331,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2213,7 +2357,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2239,7 +2383,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2267,7 +2411,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2286,7 +2430,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2310,7 +2454,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2336,7 +2480,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2362,7 +2506,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKShader @@ -2390,7 +2534,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -2405,6 +2549,28 @@ If the image is already GPU-backed, it may return the same image. + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImage + + + + + + The recorder to upload the image to. + Returns a version of this image that is uploaded to the GPU as a Graphite-backed texture. + A Graphite-backed , or if it could not be created. + + + @@ -2412,7 +2578,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -2429,6 +2595,31 @@ If the image is already GPU-backed, it may return the same image. + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImage + + + + + + + The recorder to upload the image to. + + to create the texture with mipmaps; otherwise, . + Returns a version of this image that is uploaded to the GPU as a Graphite-backed texture, optionally with mipmaps. + A Graphite-backed , or if it could not be created. + + + @@ -2436,7 +2627,7 @@ Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -2462,7 +2653,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 System.UInt32 @@ -2480,7 +2671,7 @@ Property SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Int32 diff --git a/SkiaSharpAPI/SkiaSharp/SKImageReadPixelsResult.xml b/SkiaSharpAPI/SkiaSharp/SKImageReadPixelsResult.xml new file mode 100644 index 00000000..41a53aab --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKImageReadPixelsResult.xml @@ -0,0 +1,197 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Object + + + + System.IDisposable + + + + Represents the pixel data returned by an asynchronous read-pixels request, valid only for the duration of the callback. + + or the equivalent method on and . The underlying pixels are only valid while the callback runs; to keep the data, copy it out with , , or . + +Results may be planar (for example, a YUV read has more than one plane); use to enumerate the planes. +]]> + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + + The zero-based index of the plane to copy. + The span to copy the tightly-packed pixels into. + Copies the specified plane into the destination as tightly-packed pixels, stripping any per-row padding. + + + + + + + + Method + + M:System.IDisposable.Dispose + + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + Invalidates the result so that its pixel data can no longer be accessed. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.ReadOnlySpan<System.Byte> + + + + + + The zero-based index of the plane. + Gets a read-only view over the raw pixel data of the specified plane, including any per-row padding. + A read-only span over the plane's pixel data, valid only for the duration of the callback. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Int32 + + + + + + The zero-based index of the plane. + Gets the number of bytes per row of the specified plane, including any padding. + The number of bytes per row of the plane. + + + + + + + + Property + + SkiaSharp + 4.152.0.0 + + + System.Int32 + + + Gets the number of pixel planes in the result. + The number of planes. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Byte[] + + + + + + The zero-based index of the plane to copy. + Copies the specified plane into a new tightly-packed byte array that outlives the callback. + A new byte array containing the tightly-packed plane data. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKBitmap + + + + Copies the single-plane result into a new bitmap that outlives the callback. + A new containing a copy of the result. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImage + + + + Copies the single-plane result into a new image that outlives the callback. + A new containing a copy of the result. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKImageRescaleGamma.xml b/SkiaSharpAPI/SkiaSharp/SKImageRescaleGamma.xml new file mode 100644 index 00000000..cabaac60 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKImageRescaleGamma.xml @@ -0,0 +1,52 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Enum + + + Specifies the gamma space in which rescaling is performed during an asynchronous read-pixels operation. + + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImageRescaleGamma + + 1 + + Rescaling is performed in a linear gamma space. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImageRescaleGamma + + 0 + + Rescaling is performed in the color space of the source pixels. + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKImageRescaleMode.xml b/SkiaSharpAPI/SkiaSharp/SKImageRescaleMode.xml new file mode 100644 index 00000000..6529fbdd --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/SKImageRescaleMode.xml @@ -0,0 +1,86 @@ + + + + + + SkiaSharp + 4.152.0.0 + + + System.Enum + + + Specifies the sampling algorithm used to rescale pixels during an asynchronous read-pixels operation. + + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImageRescaleMode + + 1 + + Uses a single bilinear sampling step. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImageRescaleMode + + 0 + + Uses nearest-neighbor sampling. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImageRescaleMode + + 3 + + Uses repeated bicubic sampling steps, halving the size each pass, for the highest-quality downscaling. + + + + + + + Field + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKImageRescaleMode + + 2 + + Uses repeated bilinear sampling steps, halving the size each pass, for higher-quality downscaling. + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index 1e8a782c..58509234 100644 --- a/SkiaSharpAPI/SkiaSharp/SKSurface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKSurface.xml @@ -4,7 +4,7 @@ SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKObject @@ -71,7 +71,7 @@ The example above produces the following: Property SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKCanvas @@ -89,7 +89,7 @@ The example above produces the following: Property SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.GRRecordingContext @@ -107,7 +107,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -129,7 +129,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -144,6 +144,30 @@ The example above produces the following: + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKSurface + + + + + + + The recorder that the surface is created for. + The image info describing the size and format of the surface. + Creates a Graphite-backed surface for the specified recorder. + A new , or if it could not be created. + + + @@ -151,7 +175,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -175,7 +199,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -199,7 +223,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -223,7 +247,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -247,7 +271,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -273,7 +297,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -299,7 +323,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -325,7 +349,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -351,7 +375,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -377,7 +401,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -396,6 +420,85 @@ The example above produces the following: + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKSurface + + + + + + + + The recorder that the surface is created for. + The backend texture to render into. + One of the enumeration values that specifies the color type of the texture. + Creates a Graphite-backed surface that renders into an existing backend texture. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKSurface + + + + + + + + The recorder that the surface is created for. + The image info describing the size and format of the surface. + The surface properties to use. + Creates a Graphite-backed surface for the specified recorder, using the specified surface properties. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKSurface + + + + + + + + The recorder that the surface is created for. + The image info describing the size and format of the surface. + + to allocate the surface with mipmaps; otherwise, . + Creates a Graphite-backed surface for the specified recorder, optionally with mipmaps. + A new , or if it could not be created. + + + @@ -403,7 +506,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -429,7 +532,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -455,7 +558,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -481,7 +584,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -509,7 +612,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -537,7 +640,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -565,7 +668,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -593,7 +696,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -621,7 +724,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -649,7 +752,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -677,7 +780,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -705,7 +808,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -733,7 +836,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -761,7 +864,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -789,7 +892,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -810,6 +913,63 @@ The example above produces the following: + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKSurface + + + + + + + + + The recorder that the surface is created for. + The backend texture to render into. + One of the enumeration values that specifies the color type of the texture. + The color space of the texture, or to use no color space. + Creates a Graphite-backed surface that renders into an existing backend texture, using the specified color space. + A new , or if it could not be created. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKSurface + + + + + + + + + The recorder that the surface is created for. + The image info describing the size and format of the surface. + + to allocate the surface with mipmaps; otherwise, . + The surface properties to use. + Creates a Graphite-backed surface for the specified recorder, optionally with mipmaps and using the specified surface properties. + A new , or if it could not be created. + + + @@ -817,7 +977,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -845,7 +1005,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -875,7 +1035,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -905,7 +1065,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -935,7 +1095,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -965,7 +1125,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -995,7 +1155,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1025,7 +1185,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1055,7 +1215,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1085,7 +1245,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1115,7 +1275,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1145,7 +1305,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1175,7 +1335,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1198,6 +1358,36 @@ The example above produces the following: + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKSurface + + + + + + + + + + The recorder that the surface is created for. + The backend texture to render into. + One of the enumeration values that specifies the color type of the texture. + The color space of the texture, or to use no color space. + The surface properties to use. + Creates a Graphite-backed surface that renders into an existing backend texture, using the specified color space and surface properties. + A new , or if it could not be created. + + + @@ -1205,7 +1395,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1235,7 +1425,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1267,7 +1457,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1299,7 +1489,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1331,7 +1521,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1363,7 +1553,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1395,7 +1585,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1420,6 +1610,38 @@ The example above produces the following: + + + + + Method + + SkiaSharp + 4.152.0.0 + + + SkiaSharp.SKSurface + + + + + + + + + + + The recorder that the surface is created for. + The backend texture to render into. + One of the enumeration values that specifies the color type of the texture. + The color space of the texture, or to use no color space. + The surface properties to use. + The callback invoked when Skia is finished using the texture, or for none. + Creates a Graphite-backed surface that renders into an existing backend texture, invoking a callback when Skia no longer needs the texture. + A new , or if it could not be created. + + + @@ -1427,7 +1649,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1459,7 +1681,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1493,7 +1715,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1527,7 +1749,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1561,7 +1783,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1595,7 +1817,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurface @@ -1619,7 +1841,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -1641,7 +1863,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -1659,7 +1881,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -1686,7 +1908,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -1713,7 +1935,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -1742,7 +1964,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -1760,7 +1982,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Void @@ -1783,7 +2005,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKPixmap @@ -1802,7 +2024,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1824,7 +2046,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 System.Boolean @@ -1847,6 +2069,60 @@ The example above produces the following: This method may return if the source rectangle [, , dstInfo.Width, dstInfo.Height] does not intersect the surface, or if the color type/alpha type could not be converted to the destination types. + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + + + The image info describing the desired size and format of the result. + The rectangle of the surface to read, in pixels. + The callback invoked with the read result, which is valid only for the duration of the call. + Asynchronously reads pixels from the surface into a result delivered to a callback, using nearest sampling. + + + + + + + + Method + + SkiaSharp + 4.152.0.0 + + + System.Void + + + + + + + + + + The image info describing the desired size and format of the result. + The rectangle of the surface to read, in pixels. + One of the enumeration values that specifies the gamma space used for rescaling. + One of the enumeration values that specifies the sampling algorithm used for rescaling. + The callback invoked with the read result, which is valid only for the duration of the call. + Asynchronously reads and rescales pixels from the surface into a result delivered to a callback. + + + @@ -1854,7 +2130,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1873,7 +2149,7 @@ The example above produces the following: Method SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKImage @@ -1895,7 +2171,7 @@ The example above produces the following: Property SkiaSharp - 4.150.0.0 + 4.152.0.0 SkiaSharp.SKSurfaceProperties