Skip to content

TextStudioGlyphImageSnapshot

ClassTextStudioTextStudio
public sealed class TextStudioGlyphImageSnapshot

Owned, immutable, bottom-row-first RGBA image in a glyph's baseline plane. Workers may read this object without a Texture or backend lifetime.

public const int MaximumDimension = 1024

Returns

System.Int32

public const int MaximumPixelCount = 1048576

Returns

System.Int32

CopyFrom(in TextStudioGlyphImageRequest, int, int, Rect, TextStudioGlyphImageColorSpace, TextStudioGlyphImageAlpha, ReadOnlySpan, long)

Section titled “CopyFrom(in TextStudioGlyphImageRequest, int, int, Rect, TextStudioGlyphImageColorSpace, TextStudioGlyphImageAlpha, ReadOnlySpan, long)”
public static TextStudioGlyphImageSnapshot CopyFrom(in TextStudioGlyphImageRequest request, int width, int height, Rect baselineBounds, TextStudioGlyphImageColorSpace colorSpace, TextStudioGlyphImageAlpha alpha, ReadOnlySpan<Color32> pixels, long bindingRevision = 0)

Defensively copies complete RGBA bytes. Transparent pixels remain represented and no atlas rectangle is sampled implicitly.

Parameters

Name Type
request TextStudio.TextStudioGlyphImageRequest
width System.Int32
height System.Int32
baselineBounds UnityEngine.Rect
colorSpace TextStudio.TextStudioGlyphImageColorSpace
alpha TextStudio.TextStudioGlyphImageAlpha
pixels System.ReadOnlySpan{UnityEngine.Color32}
bindingRevision System.Int64

Returns

TextStudio.TextStudioGlyphImageSnapshot

public Color32[] GetPixelsSnapshot()

Returns a caller-owned copy of all RGBA pixels, including transparent pixels.

Returns

UnityEngine.Color32[]

ForOccurrence(in TextStudioGlyphImageRequest, long)

Section titled “ForOccurrence(in TextStudioGlyphImageRequest, long)”
public TextStudioGlyphImageSnapshot ForOccurrence(in TextStudioGlyphImageRequest request, long bindingRevision)

Reuses owned pixels for the same exact raster identity at another shaped occurrence or binding generation.

Parameters

Name Type
request TextStudio.TextStudioGlyphImageRequest
bindingRevision System.Int64

Returns

TextStudio.TextStudioGlyphImageSnapshot

public TextStudioGlyphImageRequest Request { get; }

Returns

TextStudio.TextStudioGlyphImageRequest

public int Width { get; }

Returns

System.Int32

public int Height { get; }

Returns

System.Int32

public Rect BaselineBounds { get; }

Returns

UnityEngine.Rect

public Vector2 PixelsPerEm { get; }

Returns

UnityEngine.Vector2

public TextStudioGlyphImageColorSpace ColorSpace { get; }

Returns

TextStudio.TextStudioGlyphImageColorSpace

public TextStudioGlyphImageAlpha Alpha { get; }

Returns

TextStudio.TextStudioGlyphImageAlpha

public long BindingRevision { get; }

Atlas/binding generation, deliberately excluded from image and silhouette content identity.

Returns

System.Int64

public string ContentHash { get; }

Returns

System.String

public string AlphaContentHash { get; }

Returns

System.String

public ReadOnlySpan<Color32> Pixels { get; }

Returns

System.ReadOnlySpan{UnityEngine.Color32}

public long PixelByteCount { get; }

Returns

System.Int64