Class RasterImageCommand

Describes a raster image to compose through the output buffer.

public class RasterImageCommand

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AlwaysRender: Gets or sets whether the image should be emitted on every driver write.

Clip: Gets or sets the clip region captured when the image is added to the output buffer.

EncodedKitty: Gets or sets pre-encoded Kitty graphics protocol data for Pixels.

Encoder: Gets or sets the sixel encoder to use. A default encoder is used when this is null.

IsDirty: Gets or sets whether the image needs to be emitted during the next driver write.

RenderAfterText: Gets or sets whether the image should be emitted after dirty text cells rather than before them.

SourceRect: When set (Kitty only), Pixels is the full source image and this is the crop of it (in image pixels) to display in DestinationCells. The image is transmitted to the terminal once; subsequent frames that only change the crop/destination (pan, zoom of a static image) emit a tiny placement update instead of re-sending the pixels, avoiding the per-frame flash. When null the legacy path is used: Pixels is the already-scaled region and is (re)transmitted each dirty frame.

SourceVersion: A monotonic version of the Pixels contents, used only by the Kitty source-crop path to decide whether the resident image must be re-transmitted. The source-crop path keeps the full image resident in the terminal and pans/zooms it with placement updates; it re-transmits when this version changes. Hosts (e.g. ImageView) should bump it whenever the pixel contents change — including when the same array instance is reused for a new render, which a reference comparison alone would miss.