LineDisplayCustomGlyphs LineDisplayCustomGlyphs LineDisplayCustomGlyphs LineDisplayCustomGlyphs Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents a set of custom glyphs to be used by a line display.

public : sealed class LineDisplayCustomGlyphs : ILineDisplayCustomGlyphspublic sealed class LineDisplayCustomGlyphs : ILineDisplayCustomGlyphsPublic NotInheritable Class LineDisplayCustomGlyphs Implements ILineDisplayCustomGlyphs// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Properties

SizeInPixels SizeInPixels SizeInPixels SizeInPixels

Prerelease. Gets the glyph dimensions (based on the number of pixels for a character cell) supported by the device

public : Size SizeInPixels { get; }public Size SizeInPixels { get; }Public ReadOnly Property SizeInPixels As Size// You can use this property in JavaScript.
Value
Size Size Size Size

The glyph dimensions, in pixels.

SupportedGlyphCodes SupportedGlyphCodes SupportedGlyphCodes SupportedGlyphCodes

Prerelease. Gets the list of character codes available for redefinition as custom glyphs.

public : IVectorView<uint> SupportedGlyphCodes { get; }public IReadOnlyList<uint> SupportedGlyphCodes { get; }Public ReadOnly Property SupportedGlyphCodes As IReadOnlyList<uint>// You can use this property in JavaScript.
Value
IVectorView<unsigned int> IReadOnlyList<uint> IReadOnlyList<uint> IReadOnlyList<uint>

The list of character codes.

Methods

TryRedefineAsync(UInt32, IBuffer) TryRedefineAsync(UInt32, IBuffer) TryRedefineAsync(UInt32, IBuffer) TryRedefineAsync(UInt32, IBuffer)

Prerelease. Attempts to asynchronously define a custom glyph.

public : IAsyncOperation<PlatForm::Boolean> TryRedefineAsync(unsigned int glyphCode, IBuffer glyphData)public IAsyncOperation<bool> TryRedefineAsync(UInt32 glyphCode, IBuffer glyphData)Public Function TryRedefineAsync(glyphCode As UInt32, glyphData As IBuffer) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
glyphCode
unsigned int UInt32 UInt32 UInt32

The character for which the glyph will be defined.

glyphData
IBuffer IBuffer IBuffer IBuffer

The glyph data.

Returns

Returns True if the glyph was successfully defined; otherwise, False.

Remarks

The glyph is defined as bits representing each pixel packed into bytes, using whole bytes to represent each row.

The minimum number of bytes are sent for each row, based on LineDisplayCustomGlyphs.SizeInPixels and using 8 bits per byte. Bytes are sent left-to-right across each row; if more than one byte is required per row, the leftmost byte is sent first. The lowest-order bit within a byte represents the rightmost pixel. Bits that do not represent pixels are the highest order bits and their value is ignored. Rows are sent from the top down.

A 10 pixel wide glyph would have the two leftmost pixels represented in bits 1 and 0 of the first byte, respectively. The remaining 8 pixels would be represented in the second byte.

Enough rows must be sent to define the entire character. The hardware defines whether changing the definition of a glyph causes currently displayed characters to change or the change appears only when next drawn.