BRUSHOBJ_pvGetRbrush (Compact 2013)

3/26/2014

This function retrieves a pointer to the realization of a specified brush.

Syntax

PVOID BRUSHOBJ_pvGetRbrush(
  BRUSHOBJ* pbo,
);

Parameters

• pbo
  [in] Pointer to the BRUSHOBJ structure containing the realization.

Return Value

If the function call succeeds, this function returns a pointer to the realized brush. Otherwise, this function returns NULL and logs an error code.

Remarks

The BRUSHOBJ_pvGetRbrush function is called when the brush is a pattern brush that is not yet realized. In other words, the BRUSHOBJ_pvGetRbrush function is called if, in the BRUSHOBJ structure, the value of the iSolidColor member is 0xFFFFFFFF and the value of the pvRbrush member is NULL. If the brush is not realized when the BRUSHOBJ_pvGetRbrush function is called, GDI calls the DrvRealizeBrush function to obtain the realization of the brush.

To improve performance, GDI caches this realization in the pvRbrush member of the BRUSHOBJ structure. If an application uses this brush for another drawing operation, the driver does not need to call the BRUSHOBJ_pvGetRbrush function again.

Requirements

See Also

Reference

GDI Functions for Display Drivers
BRUSHOBJ_pvAllocRbrush
DrvRealizeBrush