Skip to content

Class VulkanImage

Namespace: Apogee.Graphics.Vulkan
Assembly: Apogee.Graphics.dll

A Vulkan image with its VMA allocation and a view of the whole of it, or one that belongs to someone else (a swapchain's) and is only described here.

public sealed class VulkanImage : GpuImage, IDisposable

Inheritance

object ← GpuImage ← VulkanImage

Implements

IDisposable

Inherited Members

GpuImage.Description, GpuImage.Format, GpuImage.Width, GpuImage.Height, GpuImage.MipLevels, GpuImage.Layers, GpuImage.View, GpuImage.CreateView(uint, uint, uint, uint), GpuImage.DestroyView(ImageView), GpuImage.Dispose(), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

Aspect

All the aspects of the image, for a barrier.

public VkImageAspectFlagBits Aspect { get; }

Property Value

VkImageAspectFlagBits

Handle

public VkImage Handle { get; }

Property Value

VkImage

Layers

The number of array layers (six per cube).

public override uint Layers { get; }

Property Value

uint

View

A view of every mip and layer, with the aspect a shader samples (depth only for a depth-stencil format).

public override ImageView View { get; }

Property Value

ImageView

VulkanView

public VkImageView VulkanView { get; }

Property Value

VkImageView

Methods

CreateView(uint, uint, uint, uint)

Creates an extra view (one mip for a compute pass, one layer for a render target). The caller destroys it with .

public override ImageView CreateView(uint baseMip, uint mipCount, uint baseLayer, uint layerCount)

Parameters

baseMip uint

mipCount uint

baseLayer uint

layerCount uint

Returns

ImageView

CreateView(uint, uint, uint, uint, VkImageAspectFlagBits)

Creates an extra view with the given aspect. The caller destroys it with .

public VkImageView CreateView(uint baseMip, uint mipCount, uint baseLayer, uint layerCount, VkImageAspectFlagBits aspect)

Parameters

baseMip uint

mipCount uint

baseLayer uint

layerCount uint

aspect VkImageAspectFlagBits

Returns

VkImageView

DestroyView(ImageView)

public override void DestroyView(ImageView view)

Parameters

view ImageView

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public override void Dispose()