 | |
Gpu | |
GpuImage represents an image that is stored in the graphics card's memory.
Inheritance HierarchySystemObject
Ab4d.SharpEngine.CoreComponentBase
Ab4d.SharpEngine.CoreGpuDeviceComponent
Ab4d.SharpEngine.CoreGpuImage
Ab4d.SharpEngine.CoreComponentBase
Ab4d.SharpEngine.CoreGpuDeviceComponent
Ab4d.SharpEngine.CoreGpuImage
Namespace: Ab4d.SharpEngine.Core
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.0.9208+3b2441d6a11f923f2600f40f4296bdc3d8b46035
SyntaxC#
public class GpuImage : GpuDeviceComponent, IDisposable
The GpuImage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GpuImage(VulkanDevice, RawImageData, Boolean, String) | Constructor |
| GpuImage(VulkanDevice, RawImageData, Boolean, Boolean, ImageUsageFlags, AccessFlags, ImageLayout, PipelineStageFlags, String) | Constructor |
| GpuImage(VulkanDevice, Int32, Int32, Format, ImageUsageFlags, MemoryPropertyFlags, Int32, SampleCountFlags, ImageTiling, ImageLayout, ImageAspectFlags, Boolean, Int32, Boolean, String) | Constructor that created a gpu image and allocates its memory based on the image parameters. |
Properties| Name | Description | |
|---|---|---|
 | HasTransparentPixels | Gets or sets (only at init time) a Boolean that indicates that the GpuImage has some transparent pixels, e. g. pixels with alpha color smaller than 1. This means that to show this GpuImage correctly some alpha-blending technique is required. |
| Height | Height of the image in pixels |
| Image | Gets the Vulkan Image. |
| ImageMemory | Gets the VulkanMemoryInfo that represents the memory location of the buffer |
| ImageView | Gets the Vulkan ImageView. |
| IsDataWritePostponed | True when image data is not yet written to this GpuImage because the data will be copied in the background thread. |
| IsDedicatedAllocation | Gets or sets (only at init time) a Boolean that indicates is this GpuImage is using a memory that is dedicated only to this GpuImage. This can be set by calling the constructor and passing IsDedicatedAllocation set to true. |
| IsGpuDeviceCached | Gets a Boolean that indicates that this GpuImage is cashed by the GpuDevice objects and cannot be disposed by calling Dispose method. This means the GpuImage can be shared without worrying that someone will dispose this GpuImage or that it will be disposed when the Scene is disposed. This flag is set when the GpuImage is cached by calling CacheObject(String, Object) method. By default, the Source is used as the cache key. The GpuImage will be disposed when the GpuDevice will be disposed or if it is removed from the cache and then disposed. |
| IsPreMultipliedAlpha | Gets or sets (only at init time) a Boolean that indicates that the colors in this GpuImage are alpha-premultiplied. This means that the red, green and blue values are multiplied by the alpha value. |
| IsSceneCached | Gets a Boolean that indicates that this GpuImage is cashed by Scene objects and cannot be disposed by calling Dispose method. This means the GpuImage can be shared without worrying that someone will dispose this GpuImage. This flag is set when the GpuImage is cached by calling Scene.CacheObject(String, Object) method. By default the Source is used as the cache key. The GpuImage will be disposed when the Scene will be disposed or if it is removed from the cache and then disposed. |
| MemoryProperties | Gets the MemoryPropertyFlags that were used to crate this GpuImage. |
| MemorySize | User memory size in bytes |
| Source | Source can contain file name or other string that defines the source of this GpuImage. |
| Width | Width of the image in pixels |
Methods| Name | Description | |
|---|---|---|
| CopyDataFromImage | Returns a new RawImageData with data from this image (stored in GPU memory). When the image data cannot be retrieved, then null is returned. |
| CopyDataFromImage(Byte, Int64, Int32, Boolean) | Copies data from image (stored in GPU memory) to the specified byte array. Returns true when data was copied, otherwise false is returned (when image cannot be copied from GPU memory). |
| CopyDataToImage(Byte) | Copies the data from the specified byte array to this image. The layout of the image is preserved. To set the image layout to ShaderReadOnlyOptimal or TransferSrcOptimal, call CopyDataToImage(Byte, Boolean) and set the transitionImageToShaderReadOnlyOptimalLayout parameter accordingly. |
| CopyDataToImage(Byte, Boolean) | Copies the data from the specified byte array to this image. When transitionImageToShaderReadOnlyOptimalLayout is true, the image layout is transitioned to ShaderReadOnlyOptimal; when false the image layout is set to TransferSrcOptimal. To preserve the image layout, call CopyDataToImage without transitionImageToShaderReadOnlyOptimalLayout parameter. |
| CopyDataToImage(Byte, ImageLayout, AccessFlags, PipelineStageFlags) | Copies the data from the specified byte array to this image and set the layout of the image to the specified values. |
| CopyDataToImage(CommandBuffer, GpuBuffer, Byte, ImageLayout, AccessFlags, PipelineStageFlags, UInt32, UInt32) | Copies the data from the specified byte array to this image and set the layout of the image to the specified values. |
| CopyDataToImageAsync(RawImageData, Boolean) | Copies the data from the specified RawImageData to this image in the background thread. When transitionImageToShaderReadOnlyOptimalLayout is true, the image layout is transitioned to ShaderReadOnlyOptimal; when false the image layout is set to TransferSrcOptimal. After the data is copied, the dataCopiedCallback is called with this GpuImage as a parameter. |
| CopyDataToImageAsync(RawImageData, Boolean, ActionGpuImage) | Copies the data from the specified RawImageData to this image in the background thread. When transitionImageToShaderReadOnlyOptimalLayout is true, the image layout is transitioned to ShaderReadOnlyOptimal; when false the image layout is set to TransferSrcOptimal. After the data is copied, the dataCopiedCallback is called with this GpuImage as a parameter. |
| CopyDataToImageAsync(RawImageData, ImageLayout, AccessFlags, PipelineStageFlags) | Copies the data from the specified RawImageData to this image in the background thread and set the layout of the image to the specified values. |
| CopyDataToImageAsync(RawImageData, ImageLayout, AccessFlags, PipelineStageFlags, ActionGpuImage) | Copies the data from the specified RawImageData to this image in the background thread and set the layout of the image to the specified values. After the data is copied, the dataCopiedCallback is called with this GpuImage as a parameter. |
| CopyDataToImageMipMaps | Copies the data from the array of byte array to the mip maps of this image. |
| Dispose | |
 | Dispose(Boolean) |
Dispose
(Overrides ComponentBaseDispose(Boolean)) |
| GetCurrentImageLayoutAndFlags | Gets the current image layout |
 | GetImageAspectFlags | Returns the ImageAspectFlags for the specified format. |
| GetImageLayout | Returns information about the layout of the image for the specified mip level. |
| GetImageRowStride | Returns a row stride (number of bytes in one row of image data) of the image for the specified mip level. |
| GetMappedMemoryPtr | Returns an IntPtr of the mapped memory. The IntPtr can be used to get the content of this image or to copy new content to that location. After using the memory call UnmapMemory method. |
| GetMappedMemoryPtr(Int64, Int64) | Returns an IntPtr of the mapped memory with specified offset and size. The IntPtr can be used to get the content of this image or to copy new content to that location. After using the memory call UnmapMemory method. |
| GetMappedMemorySpan | Returns a Span that can be used to get the content of this image or copy new content to that location. After using the memory call UnmapMemory method. |
| GetMappedMemorySpan(Void, Byte) | |
| ReportRenderPassFinished | ReportRenderPassFinished can be called after a RenderPass that uses this GpuImage as attachment has finished. This will update the current ImageLayout and set current AccessMask to ColorAttachmentWrite and current StageMask to ColorAttachmentOutput. |
| Resize | Resizes this image |
| ToString | (Overrides ObjectToString) |
| UnmapMemory | Unmaps the memory that was mapped by calling GetMappedMemoryPtr. |
Fields| Name | Description | |
|---|---|---|
 | AlwaysAllowCopyFromGpuImage | Gets or sets a static Boolean that specifies if GpuImages are always created with usage mode that allows copying data from the image (using CopyDataFromImage method). Note that when this value is set to false, it will be still possible to copy from most of the GpuImages (from all of those that have generated mip-maps; only images without mip-maps or with predefined mip-maps data will not allow copying of the data). The only exception are the images that are marked as transient (usage flags is not TransientAttachment; this is used for color and depth-stencil attachments). Default value is false. This can be set to true for testing. |
| ImageCreateInfo | Gets the ImageCreateInfo that was used to create this GpuImage |
See Also