Skip to content

Latest commit

 

History

History
136 lines (93 loc) · 4.7 KB

nf-d2d1_3-id2d1devicecontext4-getcolorbitmapglyphimage.md

File metadata and controls

136 lines (93 loc) · 4.7 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:d2d1_3.ID2D1DeviceContext4.GetColorBitmapGlyphImage
ID2D1DeviceContext4::GetColorBitmapGlyphImage (d2d1_3.h)
Retrieves an image of the color bitmap glyph from the color glyph cache.
GetColorBitmapGlyphImage
GetColorBitmapGlyphImage method [Direct2D]
GetColorBitmapGlyphImage method [Direct2D]
ID2D1DeviceContext4 interface
ID2D1DeviceContext4 interface [Direct2D]
GetColorBitmapGlyphImage method
ID2D1DeviceContext4.GetColorBitmapGlyphImage
ID2D1DeviceContext4::GetColorBitmapGlyphImage
d2d1_3/ID2D1DeviceContext4::GetColorBitmapGlyphImage
direct2d.id2d1devicecontext4_getcolorbitmapglyphimage
direct2d\id2d1devicecontext4_getcolorbitmapglyphimage.htm
Direct2D
493224CD-A31E-405B-A084-24C377F713A0
12/05/2018
GetColorBitmapGlyphImage, GetColorBitmapGlyphImage method [Direct2D], GetColorBitmapGlyphImage method [Direct2D],ID2D1DeviceContext4 interface, ID2D1DeviceContext4 interface [Direct2D],GetColorBitmapGlyphImage method, ID2D1DeviceContext4.GetColorBitmapGlyphImage, ID2D1DeviceContext4::GetColorBitmapGlyphImage, d2d1_3/ID2D1DeviceContext4::GetColorBitmapGlyphImage, direct2d.id2d1devicecontext4_getcolorbitmapglyphimage
d2d1_3.h
Windows
D2d1.dll
Windows
19H1
ID2D1DeviceContext4::GetColorBitmapGlyphImage
d2d1_3/ID2D1DeviceContext4::GetColorBitmapGlyphImage
c++
APIRef
kbSyntax
COM
D2d1.dll
ID2D1DeviceContext4.GetColorBitmapGlyphImage

ID2D1DeviceContext4::GetColorBitmapGlyphImage

-description

Retrieves an image of the color bitmap glyph from the color glyph cache. If the cache does not already contain the requested resource, it will be created. This method may be used to extend the lifetime of a glyph image even after it is evicted from the color glyph cache.

-parameters

-param glyphImageFormat

Type: DWRITE_GLYPH_IMAGE_FORMATS

The format for the glyph image. If there is no image data in the requested format for the requested glyph, this method will return an error.

-param glyphOrigin

Type: D2D1_POINT_2F

The origin for the glyph.

-param fontFace [in]

Type: IDWriteFontFace*

Reference to a font face which contains font face type, appropriate file references, face identification data and various font data such as metrics, names and glyph outlines.

-param fontEmSize

Type: FLOAT

The specified font size affects the choice of which bitmap to use from the font. It also affects the output glyphTransform, causing it to properly scale the glyph.

-param glyphIndex

Type: UINT16

Index of the glyph.

-param isSideways

Type: BOOL

If true, specifies that glyphs are rotated 90 degrees to the left and vertical metrics are used. Vertical writing is achieved by specifying isSideways as true and rotating the entire run 90 degrees to the right via a rotate transform.

-param worldTransform [in, optional]

Type: const D2D1_MATRIX_3X2_F*

The transform to apply to the image. This input transform affects the choice of which bitmap to use from the font. It is also factored into the output glyphTransform.

-param dpiX

Type: FLOAT

Dots per inch along the x-axis.

-param dpiY

Type: FLOAT

Dots per inch along the y-axis.

-param glyphTransform [out]

Type: D2D1_MATRIX_3X2_F*

Output transform, which transforms from the glyph's space to the same output space as the worldTransform. This includes the input glyphOrigin, the glyph's offset from the glyphOrigin, and any other required transformations.

-param glyphImage [out]

Type: ID2D1Image**

On completion contains the retrieved glyph image.

-returns

Type: HRESULT

This method returns an HRESULT success or error code.

-see-also

ID2D1DeviceContext4