LineDisplayCustomGlyphs.TryRedefineAsync(UInt32, IBuffer) Method

Definition

Namespace:

Windows.Devices.PointOfService

Attempts to asynchronously define a custom glyph.

public:
 virtual IAsyncOperation<bool> ^ TryRedefineAsync(unsigned int glyphCode, IBuffer ^ glyphData) = TryRedefineAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> TryRedefineAsync(uint32_t const& glyphCode, IBuffer const& glyphData);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> TryRedefineAsync(uint glyphCode, IBuffer glyphData);

function tryRedefineAsync(glyphCode, glyphData)

Public Function TryRedefineAsync (glyphCode As UInteger, glyphData As IBuffer) As IAsyncOperation(Of Boolean)

Parameters

glyphCode

UInt32

unsigned int

uint32_t

The character for which the glyph will be defined.

glyphData

IBuffer

The glyph data.

Returns

IAsyncOperation<Boolean>

IAsyncOperation<bool>

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

Attributes

RemoteAsyncAttribute

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.