Skip to content

Class GpuImage

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

An image with a view of the whole of it (the aspect a shader samples).

public abstract class GpuImage : IDisposable

Inheritance

object ← GpuImage

Derived

MetalImage, VulkanImage

Implements

IDisposable

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

GpuImage(in ImageDescription)

protected GpuImage(in ImageDescription description)

Parameters

description ImageDescription

Properties

Description

public ImageDescription Description { get; }

Property Value

ImageDescription

Format

public PixelFormat Format { get; }

Property Value

PixelFormat

Height

public uint Height { get; }

Property Value

uint

Layers

The number of array layers (six per cube).

public abstract uint Layers { get; }

Property Value

uint

MipLevels

public uint MipLevels { 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 abstract ImageView View { get; }

Property Value

ImageView

Width

public uint Width { get; }

Property Value

uint

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 abstract ImageView CreateView(uint baseMip, uint mipCount, uint baseLayer, uint layerCount)

Parameters

baseMip uint

mipCount uint

baseLayer uint

layerCount uint

Returns

ImageView

DestroyView(ImageView)

public abstract void DestroyView(ImageView view)

Parameters

view ImageView

Dispose()

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

public abstract void Dispose()