Skip to content

GraphicsAPI reference

Class CompletedReadback

Namespace: MicroEngine.Graphics.Devices
Assembly: MicroEngine.Graphics.dll
Guide: The graphics device

A readback whose pixels were copied when it was requested (devices that execute at submit).

C#
public sealed class CompletedReadback : ReadbackRequest

Inheritance

object ← ReadbackRequest ← CompletedReadback

Inherited Members

ReadbackRequest.Wait(), ReadbackRequest.Region, ReadbackRequest.Format, ReadbackRequest.IsCompleted, ReadbackRequest.Pixels, object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

CompletedReadback(RectI, TextureFormat, byte[])

A completed request over pixels already read.

C#
public CompletedReadback(RectI region, TextureFormat format, byte[] pixels)

Parameters

region RectI

The region read.

format TextureFormat

The format of pixels.

pixels byte[]

Tightly packed pixels of the region.

Properties

IsCompleted

Always true.

C#
public override bool IsCompleted { get; }

Property Value

bool

Methods

Collect()

Backend: copies the completed data out and releases the staging memory (called once).

C#
protected override byte[] Collect()

Returns

byte[]

Wait()

Returns at once.

C#
public override void Wait()