Interface for rendering target objects. More...

#include <SRender-i.h>

Inheritance diagram for IRenderTarget:

Public Member Functions
long	AddRef () PURE
	Increment the reference count.

long	Release () PURE
	Decrement the reference count and destroy the object if the count reaches zero.

void	OnFinalRelease () PURE
	Called when the reference count reaches zero.

void	BeginDraw () PURE
	Start a drawing operation.

void	EndDraw () PURE
	End a drawing operation.

BOOL	IsOffscreen () SCONST PURE
	Check if the render target is offscreen.

HRESULT	CreatePen (int iStyle, COLORREF cr, int cWidth, IPenS **ppPen) PURE
	Create a pen object.

HRESULT	CreateSolidColorBrush (COLORREF cr, IBrushS **ppBrush) PURE
	Create a solid color brush.

HRESULT	CreateBitmapBrush (IBitmapS pBmp, TileMode xtm, TileMode ytm, IBrushS *ppBrush) PURE
	Create a bitmap brush.

HRESULT	CreateGradientBrush (const GradientItem pGradients, int nCount, const GradientInfo info, BYTE byAlpha, TileMode tileMode, IBrushS **ppBrush) PURE
	Create a gradient brush.

HRESULT	CreateRegion (IRegionS **ppRegion) PURE
	Create a region object.

HRESULT	Resize (SIZE sz) PURE
	Resize the render target.

HRESULT	OffsetViewportOrg (int xOff, int yOff, LPPOINT lpPoint=NULL) PURE
	Offset the viewport origin.

HRESULT	GetViewportOrg (LPPOINT lpPoint) PURE
	Get the current viewport origin.

HRESULT	SetViewportOrg (POINT pt) PURE
	Set the viewport origin.

HRESULT	PushClipRect (LPCRECT pRect, UINT mode=RGN_AND) PURE
	Push a rectangular clip region.

HRESULT	PushClipRegion (IRegionS *pRegion, UINT mode=RGN_AND) PURE
	Push a region-based clip.

HRESULT	PopClip () PURE
	Pop the last clip region from the stack.

HRESULT	ExcludeClipRect (LPCRECT pRc) PURE
	Exclude a rectangle from the current clip region.

HRESULT	SaveClip (int *pnState) PURE
	Save the current clip state.

HRESULT	RestoreClip (int nState=-1) PURE
	Restore a previously saved clip state.

HRESULT	GetClipRegion (IRegionS **ppRegion) PURE
	Get the current clip region.

HRESULT	GetClipBox (LPRECT prc) PURE
	Get the bounding box of the current clip region.

HRESULT	DrawText (LPCTSTR pszText, int cchLen, LPRECT pRc, UINT uFormat) PURE
	Draw text within a rectangle.

HRESULT	MeasureText (LPCTSTR pszText, int cchLen, SIZE *psz) PURE
	Measure the size of the text.

HRESULT	TextOut (int x, int y, LPCTSTR lpszString, int nCount) PURE
	Output text at a specified position.

HRESULT	DrawRectangle (LPCRECT pRect) PURE
	Draw a rectangle outline.

HRESULT	FillRectangle (LPCRECT pRect) PURE
	Fill a rectangle with the current brush.

HRESULT	FillSolidRect (LPCRECT pRect, COLORREF cr) PURE
	Fill a rectangle with a solid color.

HRESULT	DrawRoundRect (LPCRECT pRect, POINT pt) PURE
	Draw a rounded rectangle outline.

HRESULT	FillRoundRect (LPCRECT pRect, POINT pt) PURE
	Fill a rounded rectangle with the current brush.

HRESULT	FillSolidRoundRect (LPCRECT pRect, POINT pt, COLORREF cr) PURE
	Fill a rounded rectangle with a solid color.

HRESULT	ClearRect (LPCRECT pRect, COLORREF cr) PURE
	Clear a rectangle with a solid color.

HRESULT	InvertRect (LPCRECT pRect) PURE
	Invert the colors in a rectangle.

HRESULT	DrawEllipse (LPCRECT pRect) PURE
	Draw an ellipse outline.

HRESULT	FillEllipse (LPCRECT pRect) PURE
	Fill an ellipse with the current brush.

HRESULT	FillSolidEllipse (LPCRECT pRect, COLORREF cr) PURE
	Fill an ellipse with a solid color.

HRESULT	DrawArc (LPCRECT pRect, float startAngle, float sweepAngle, BOOL useCenter) PURE
	Draw an arc.

HRESULT	DrawArc2 (LPCRECT pRect, float startAngle, float sweepAngle, int width) PURE
	Draw an arc with a specified line width.

HRESULT	FillArc (LPCRECT pRect, float startAngle, float sweepAngle) PURE
	Fill an arc.

HRESULT	DrawLines (LPPOINT pPt, size_t nCount) PURE
	Draw a series of connected lines.

HRESULT	DrawGradientRect (LPCRECT pRect, BOOL bVert, POINT ptRoundCorner, const GradientItem *pGradients, int nCount, BYTE byAlpha=0xFF) PURE
	Draw a gradient-filled rectangle.

HRESULT	DrawGradientRectEx (LPCRECT pRect, POINT ptRoundCorner, const GradientItem pGradients, int nCount, const GradientInfo info, BYTE byAlpha=0xFF) PURE
	Draw an extended gradient-filled rectangle.

HRESULT	DrawGradientPath (const IPathS path, const GradientItem pGradients, int nCount, const GradientInfo *info, BYTE byAlpha=0xFF) PURE
	Draw a gradient-filled path.

HRESULT	DrawIconEx (int xLeft, int yTop, HICON hIcon, int cxWidth, int cyWidth, UINT diFlags) PURE
	Draw an icon.

HRESULT	DrawBitmap (LPCRECT pRcDest, const IBitmapS *pBitmap, int xSrc, int ySrc, BYTE byAlpha=0xFF) PURE
	Draw a bitmap.

HRESULT	DrawBitmapEx (LPCRECT pRcDest, const IBitmapS *pBitmap, LPCRECT pRcSrc, UINT expendMode, BYTE byAlpha=0xFF) PURE
	Draws a bitmap with expansion mode.

HRESULT	DrawBitmap9Patch (LPCRECT pRcDest, const IBitmapS *pBitmap, LPCRECT pRcSrc, LPCRECT pRcSourMargin, UINT expendMode, BYTE byAlpha=0xFF) PURE
	Draws a 9-patch bitmap.

HRESULT	BitBlt (LPCRECT pRcDest, IRenderTarget *pRTSour, int xSrc, int ySrc, DWORD dwRop=kSrcCopy) PURE
	Performs a bit-block transfer (BitBlt) operation.

HRESULT	AlphaBlend (LPCRECT pRcDest, IRenderTarget *pRTSrc, LPCRECT pRcSrc, BYTE byAlpha) PURE
	Performs an alpha-blended transfer from one render target to another.

IRenderObj *	GetCurrentObject (OBJTYPE uType) PURE
	Retrieves the current rendering object of the specified type.

HRESULT	SelectDefaultObject (OBJTYPE objType, IRenderObj **pOldObj=NULL) PURE
	Resets the specified rendering object to its default state.

HRESULT	SelectObject (IRenderObj pObj, IRenderObj *pOldObj=NULL) PURE
	Selects a new rendering object and optionally retrieves the previous one.

COLORREF	GetTextColor () PURE
	Retrieves the current text color.

COLORREF	SetTextColor (COLORREF color) PURE
	Sets the current text color.

void	SetMaskFilter (IMaskFilter *pMaskFilter) PURE
	Sets the mask filter for anti-aliasing effects.

IMaskFilter *	GetMaskFilter () PURE
	Retrieves the current mask filter.

HDC	GetDC (UINT uFlag) PURE
	Retrieves a device context (DC) compatible with the render target.

void	ReleaseDC (HDC hdc, LPCRECT pRc=NULL) PURE
	Releases a previously retrieved device context (DC).

HRESULT	SetTransform (const float matrix[9], float oldMatrix[9]=NULL) PURE
	Sets the coordinate transformation matrix.

HRESULT	GetTransform (float matrix[9]) SCONST PURE
	Retrieves the current coordinate transformation matrix.

COLORREF	GetPixel (int x, int y) PURE
	Retrieves the color of a specific pixel.

COLORREF	SetPixel (int x, int y, COLORREF cr) PURE
	Sets the color of a specific pixel.

HRESULT	PushClipPath (const IPathS *path, UINT mode, BOOL doAntiAlias=FALSE) PURE
	Modifies the current clipping region using a path.

HRESULT	DrawPath (const IPathS path, IPathEffect pathEffect=NULL) PURE
	Draws the outline of a path using the currently selected pen.

HRESULT	FillPath (const IPathS *path) PURE
	Fills the interior of a path using the currently selected brush.

HRESULT	SetXfermode (int mode, int *pOldMode=NULL) PURE
	Sets the transfer mode for drawing operations.

BOOL	SetAntiAlias (BOOL bAntiAlias) PURE
	Enables or disables anti-aliasing for drawing operations.

BOOL	GetAntiAlias () SCONST PURE
	Retrieves the current anti-aliasing state.

Public Member Functions inherited from IObjRef
long	AddRef () PURE
	Increases the reference count.

long	Release () PURE
	Decreases the reference count.

void	OnFinalRelease () PURE
	Called when the reference count reaches zero and the object is about to be released.

Detailed Description

Interface for rendering target objects.

This interface provides methods for drawing, clipping, transforming, and managing rendering resources such as pens, brushes, and bitmaps. It also supports advanced operations like anti-aliasing, blending, and path-based drawing.

Definition at line 1439 of file SRender-i.h.

Member Function Documentation

◆ AddRef()

long IRenderTarget::AddRef ( )

Increment the reference count.

Returns: New reference count.

◆ AlphaBlend()

HRESULT IRenderTarget::AlphaBlend	(	LPCRECT	pRcDest,
		IRenderTarget *	pRTSrc,
		LPCRECT	pRcSrc,
		BYTE	byAlpha )

Performs an alpha-blended transfer from one render target to another.

Parameters

pRcDest	Destination rectangle for the alpha blend.
pRTSrc	Pointer to the source render target.
pRcSrc	Source rectangle for the alpha blend.
byAlpha	Alpha value for blending.

Returns: HRESULT indicating success or failure.

◆ BitBlt()

HRESULT IRenderTarget::BitBlt	(	LPCRECT	pRcDest,
		IRenderTarget *	pRTSour,
		int	xSrc,
		int	ySrc,
		DWORD	dwRop = kSrcCopy )

Performs a bit-block transfer (BitBlt) operation.

Parameters

pRcDest	Destination rectangle for the BitBlt operation.
pRTSour	Pointer to the source render target.
xSrc	X-coordinate of the source point.
ySrc	Y-coordinate of the source point.
dwRop	Raster operation code (default is kSrcCopy).

Returns: HRESULT indicating success or failure.

◆ ClearRect()

HRESULT IRenderTarget::ClearRect	(	LPCRECT	pRect,
		COLORREF	cr )

Clear a rectangle with a solid color.

Parameters

pRect	Rectangle to clear.
cr	Clear color.

Returns: HRESULT indicating success or failure.

◆ CreateBitmapBrush()

HRESULT IRenderTarget::CreateBitmapBrush	(	IBitmapS *	pBmp,
		TileMode	xtm,
		TileMode	ytm,
		IBrushS **	ppBrush )

Create a bitmap brush.

Parameters

pBmp	Bitmap object.
xtm	X-axis tile mode.
ytm	Y-axis tile mode.
ppBrush	Pointer to the created brush object.

Returns: HRESULT indicating success or failure.

◆ CreateGradientBrush()

HRESULT IRenderTarget::CreateGradientBrush	(	const GradientItem *	pGradients,
		int	nCount,
		const GradientInfo *	info,
		BYTE	byAlpha,
		TileMode	tileMode,
		IBrushS **	ppBrush )

Create a gradient brush.

Parameters

pGradients	Array of gradient items.
nCount	Number of gradient items.
info	Gradient information.
byAlpha	Alpha value for the gradient.
tileMode	Tile mode for the gradient.
ppBrush	Pointer to the created brush object.

Returns: HRESULT indicating success or failure.

◆ CreatePen()

HRESULT IRenderTarget::CreatePen	(	int	iStyle,
		COLORREF	cr,
		int	cWidth,
		IPenS **	ppPen )

Create a pen object.

Parameters

iStyle	Pen style.
cr	Pen color.
cWidth	Pen width.
ppPen	Pointer to the created pen object.

Returns: HRESULT indicating success or failure.

◆ CreateRegion()

HRESULT IRenderTarget::CreateRegion ( IRegionS ** ppRegion )

Create a region object.

Parameters

ppRegion Pointer to the created region object.

Returns: HRESULT indicating success or failure.

◆ CreateSolidColorBrush()

HRESULT IRenderTarget::CreateSolidColorBrush	(	COLORREF	cr,
		IBrushS **	ppBrush )

Create a solid color brush.

Parameters

cr	Brush color.
ppBrush	Pointer to the created brush object.

Returns: HRESULT indicating success or failure.

◆ DrawArc()

HRESULT IRenderTarget::DrawArc	(	LPCRECT	pRect,
		float	startAngle,
		float	sweepAngle,
		BOOL	useCenter )

Draw an arc.

Parameters

pRect	Rectangle defining the bounds of the arc.
startAngle	Starting angle (in degrees) where the arc begins.
sweepAngle	Sweep angle (in degrees) measured clockwise.
useCenter	Whether to use the center point.

Returns: HRESULT indicating success or failure.

◆ DrawArc2()

HRESULT IRenderTarget::DrawArc2	(	LPCRECT	pRect,
		float	startAngle,
		float	sweepAngle,
		int	width )

Draw an arc with a specified line width.

Parameters

pRect	Rectangle defining the bounds of the arc.
startAngle	Starting angle (in degrees) where the arc begins.
sweepAngle	Sweep angle (in degrees) measured clockwise.
width	Line width of the arc.

Returns: HRESULT indicating success or failure.

◆ DrawBitmap()

HRESULT IRenderTarget::DrawBitmap	(	LPCRECT	pRcDest,
		const IBitmapS *	pBitmap,
		int	xSrc,
		int	ySrc,
		BYTE	byAlpha = 0xFF )

Draw a bitmap.

Parameters

pRcDest	Destination rectangle.
pBitmap	Bitmap object.
xSrc	Source X position.
ySrc	Source Y position.
byAlpha	Alpha value for blending.

Returns: HRESULT indicating success or failure.

◆ DrawBitmap9Patch()

HRESULT IRenderTarget::DrawBitmap9Patch	(	LPCRECT	pRcDest,
		const IBitmapS *	pBitmap,
		LPCRECT	pRcSrc,
		LPCRECT	pRcSourMargin,
		UINT	expendMode,
		BYTE	byAlpha = 0xFF )

Draws a 9-patch bitmap.

Parameters

pRcDest	Destination rectangle for the bitmap.
pBitmap	Pointer to the bitmap object to draw.
pRcSrc	Source rectangle within the bitmap.
pRcSourMargin	Margins for the 9-patch source.
expendMode	Expansion mode (e.g., stretch, tile).
byAlpha	Optional alpha value for blending (default is 0xFF).

Returns: HRESULT indicating success or failure.

◆ DrawBitmapEx()

HRESULT IRenderTarget::DrawBitmapEx	(	LPCRECT	pRcDest,
		const IBitmapS *	pBitmap,
		LPCRECT	pRcSrc,
		UINT	expendMode,
		BYTE	byAlpha = 0xFF )

Draws a bitmap with expansion mode.

Parameters

pRcDest	Destination rectangle for the bitmap.
pBitmap	Pointer to the bitmap object to draw.
pRcSrc	Source rectangle within the bitmap.
expendMode	Expansion mode (e.g., stretch, tile).
byAlpha	Optional alpha value for blending (default is 0xFF).

Returns: HRESULT indicating success or failure.

◆ DrawEllipse()

HRESULT IRenderTarget::DrawEllipse ( LPCRECT pRect )

Draw an ellipse outline.

Parameters

pRect Rectangle defining the bounds of the ellipse.

Returns: HRESULT indicating success or failure.

◆ DrawGradientPath()

HRESULT IRenderTarget::DrawGradientPath	(	const IPathS *	path,
		const GradientItem *	pGradients,
		int	nCount,
		const GradientInfo *	info,
		BYTE	byAlpha = 0xFF )

Draw a gradient-filled path.

Parameters

path	Path object.
pGradients	Array of gradient items.
nCount	Number of gradient items.
info	Gradient information.
byAlpha	Alpha value for the gradient.

Returns: HRESULT indicating success or failure.

◆ DrawGradientRect()

HRESULT IRenderTarget::DrawGradientRect	(	LPCRECT	pRect,
		BOOL	bVert,
		POINT	ptRoundCorner,
		const GradientItem *	pGradients,
		int	nCount,
		BYTE	byAlpha = 0xFF )

Draw a gradient-filled rectangle.

Parameters

pRect	Rectangle to fill.
bVert	Vertical gradient flag.
ptRoundCorner	X and Y radii for rounded corners.
pGradients	Array of gradient items.
nCount	Number of gradient items.
byAlpha	Alpha value for the gradient.

Returns: HRESULT indicating success or failure.

◆ DrawGradientRectEx()

HRESULT IRenderTarget::DrawGradientRectEx	(	LPCRECT	pRect,
		POINT	ptRoundCorner,
		const GradientItem *	pGradients,
		int	nCount,
		const GradientInfo *	info,
		BYTE	byAlpha = 0xFF )

Draw an extended gradient-filled rectangle.

Parameters

pRect	Rectangle to fill.
ptRoundCorner	X and Y radii for rounded corners.
pGradients	Array of gradient items.
nCount	Number of gradient items.
info	Gradient information.
byAlpha	Alpha value for the gradient.

Returns: HRESULT indicating success or failure.

◆ DrawIconEx()

HRESULT IRenderTarget::DrawIconEx	(	int	xLeft,
		int	yTop,
		HICON	hIcon,
		int	cxWidth,
		int	cyWidth,
		UINT	diFlags )

Draw an icon.

Parameters

xLeft	Left position of the icon.
yTop	Top position of the icon.
hIcon	Icon handle.
cxWidth	Width of the icon.
cyWidth	Height of the icon.
diFlags	Drawing flags.

Returns: HRESULT indicating success or failure.

◆ DrawLines()

HRESULT IRenderTarget::DrawLines	(	LPPOINT	pPt,
		size_t	nCount )

Draw a series of connected lines.

Parameters

pPt	Array of points defining the lines.
nCount	Number of points.

Returns: HRESULT indicating success or failure.

◆ DrawPath()

HRESULT IRenderTarget::DrawPath	(	const IPathS *	path,
		IPathEffect *	pathEffect = NULL )

Draws the outline of a path using the currently selected pen.

Parameters

path	Pointer to the path object to draw.
pathEffect	Optional pointer to a path effect object (default is NULL).

Returns: HRESULT indicating success or failure.

◆ DrawRectangle()

HRESULT IRenderTarget::DrawRectangle ( LPCRECT pRect )

Draw a rectangle outline.

Parameters

pRect Rectangle to draw.

Returns: HRESULT indicating success or failure.

◆ DrawRoundRect()

HRESULT IRenderTarget::DrawRoundRect	(	LPCRECT	pRect,
		POINT	pt )

Draw a rounded rectangle outline.

Parameters

pRect	Rectangle defining the bounds of the rounded rectangle.
pt	X and Y radii for the rounded corners.

Returns: HRESULT indicating success or failure.

◆ DrawText()

HRESULT IRenderTarget::DrawText	(	LPCTSTR	pszText,
		int	cchLen,
		LPRECT	pRc,
		UINT	uFormat )

Draw text within a rectangle.

Parameters

pszText	Text to draw.
cchLen	Length of the text.
pRc	Rectangle defining the drawing area.
uFormat	Text formatting options.

Returns: HRESULT indicating success or failure.

◆ ExcludeClipRect()

HRESULT IRenderTarget::ExcludeClipRect ( LPCRECT pRc )

Exclude a rectangle from the current clip region.

Parameters

pRc	Rectangle to exclude.

Returns: HRESULT indicating success or failure.

◆ FillArc()

HRESULT IRenderTarget::FillArc	(	LPCRECT	pRect,
		float	startAngle,
		float	sweepAngle )

Fill an arc.

Parameters

pRect	Rectangle defining the bounds of the arc.
startAngle	Starting angle (in degrees) where the arc begins.
sweepAngle	Sweep angle (in degrees) measured clockwise.

Returns: HRESULT indicating success or failure.

◆ FillEllipse()

HRESULT IRenderTarget::FillEllipse ( LPCRECT pRect )

Fill an ellipse with the current brush.

Parameters

pRect Rectangle defining the bounds of the ellipse.

Returns: HRESULT indicating success or failure.

◆ FillPath()

HRESULT IRenderTarget::FillPath ( const IPathS * path )

Fills the interior of a path using the currently selected brush.

Parameters

path	Pointer to the path object to fill.

Returns: HRESULT indicating success or failure.

◆ FillRectangle()

HRESULT IRenderTarget::FillRectangle ( LPCRECT pRect )

Fill a rectangle with the current brush.

Parameters

pRect Rectangle to fill.

Returns: HRESULT indicating success or failure.

◆ FillRoundRect()

HRESULT IRenderTarget::FillRoundRect	(	LPCRECT	pRect,
		POINT	pt )

Fill a rounded rectangle with the current brush.

Parameters

pRect	Rectangle defining the bounds of the rounded rectangle.
pt	X and Y radii for the rounded corners.

Returns: HRESULT indicating success or failure.

◆ FillSolidEllipse()

HRESULT IRenderTarget::FillSolidEllipse	(	LPCRECT	pRect,
		COLORREF	cr )

Fill an ellipse with a solid color.

Parameters

pRect	Rectangle defining the bounds of the ellipse.
cr	Solid color.

Returns: HRESULT indicating success or failure.

◆ FillSolidRect()

HRESULT IRenderTarget::FillSolidRect	(	LPCRECT	pRect,
		COLORREF	cr )

Fill a rectangle with a solid color.

Parameters

pRect	Rectangle to fill.
cr	Solid color.

Returns: HRESULT indicating success or failure.

◆ FillSolidRoundRect()

HRESULT IRenderTarget::FillSolidRoundRect	(	LPCRECT	pRect,
		POINT	pt,
		COLORREF	cr )

Fill a rounded rectangle with a solid color.

Parameters

pRect	Rectangle defining the bounds of the rounded rectangle.
pt	X and Y radii for the rounded corners.
cr	Solid color.

Returns: HRESULT indicating success or failure.

◆ GetAntiAlias()

BOOL IRenderTarget::GetAntiAlias ( )

Retrieves the current anti-aliasing state.

Returns: BOOL indicating whether anti-aliasing is enabled.

◆ GetClipBox()

HRESULT IRenderTarget::GetClipBox ( LPRECT prc )

Get the bounding box of the current clip region.

Parameters

prc	Pointer to receive the bounding box rectangle.

Returns: HRESULT indicating success or failure.

◆ GetClipRegion()

HRESULT IRenderTarget::GetClipRegion ( IRegionS ** ppRegion )

Get the current clip region.

Parameters

ppRegion Pointer to receive the clip region object.

Returns: HRESULT indicating success or failure.

◆ GetCurrentObject()

IRenderObj * IRenderTarget::GetCurrentObject ( OBJTYPE uType )

Retrieves the current rendering object of the specified type.

Parameters

uType Type of the rendering object (e.g., pen, brush).

Returns: Pointer to the current rendering object.

◆ GetDC()

HDC IRenderTarget::GetDC ( UINT uFlag )

Retrieves a device context (DC) compatible with the render target.

Parameters

uFlag Flags for DC retrieval.

Returns: Handle to the device context (HDC).

◆ GetMaskFilter()

IMaskFilter * IRenderTarget::GetMaskFilter ( )

Retrieves the current mask filter.

Returns: Pointer to the current mask filter object.

◆ GetPixel()

COLORREF IRenderTarget::GetPixel	(	int	x,
		int	y )

Retrieves the color of a specific pixel.

Parameters

x	X-coordinate of the pixel.
y	Y-coordinate of the pixel.

Returns: COLORREF representing the color of the pixel.

◆ GetTextColor()

COLORREF IRenderTarget::GetTextColor ( )

Retrieves the current text color.

Returns: COLORREF representing the current text color.

◆ GetTransform()

HRESULT IRenderTarget::GetTransform ( float matrix[9] )

Retrieves the current coordinate transformation matrix.

Parameters

matrix Array of 9 floats to store the current 2x3 transformation matrix.

Returns: HRESULT indicating success or failure.

◆ GetViewportOrg()

HRESULT IRenderTarget::GetViewportOrg ( LPPOINT lpPoint )

Get the current viewport origin.

Parameters

lpPoint Pointer to receive the viewport origin.

Returns: HRESULT indicating success or failure.

◆ InvertRect()

HRESULT IRenderTarget::InvertRect ( LPCRECT pRect )

Invert the colors in a rectangle.

Parameters

pRect Rectangle to invert.

Returns: HRESULT indicating success or failure.

◆ IsOffscreen()

BOOL IRenderTarget::IsOffscreen ( )

Check if the render target is offscreen.

Returns: TRUE if offscreen, FALSE otherwise.

◆ MeasureText()

HRESULT IRenderTarget::MeasureText	(	LPCTSTR	pszText,
		int	cchLen,
		SIZE *	psz )

Measure the size of the text.

Parameters

pszText	Text to measure.
cchLen	Length of the text.
psz	Pointer to receive the measured size.

Returns: HRESULT indicating success or failure.

◆ OffsetViewportOrg()

HRESULT IRenderTarget::OffsetViewportOrg	(	int	xOff,
		int	yOff,
		LPPOINT	lpPoint = NULL )

Offset the viewport origin.

Parameters

xOff	Offset in the X direction.
yOff	Offset in the Y direction.
lpPoint	Optional pointer to receive the previous viewport origin.

Returns: HRESULT indicating success or failure.

◆ PopClip()

HRESULT IRenderTarget::PopClip ( )

Pop the last clip region from the stack.

Returns: HRESULT indicating success or failure.

◆ PushClipPath()

HRESULT IRenderTarget::PushClipPath	(	const IPathS *	path,
		UINT	mode,
		BOOL	doAntiAlias = FALSE )

Modifies the current clipping region using a path.

Parameters

path	Pointer to the path object to combine with the current clip.
mode	Region operation mode (e.g., RGN_AND, RGN_OR).
doAntiAlias	Boolean indicating whether anti-aliasing should be applied (default is FALSE).

Returns: HRESULT indicating success or failure.

◆ PushClipRect()

HRESULT IRenderTarget::PushClipRect	(	LPCRECT	pRect,
		UINT	mode = RGN_AND )

Push a rectangular clip region.

Parameters

pRect	Rectangle defining the clip region.
mode	Region operation mode.

Returns: HRESULT indicating success or failure.

◆ PushClipRegion()

HRESULT IRenderTarget::PushClipRegion	(	IRegionS *	pRegion,
		UINT	mode = RGN_AND )

Push a region-based clip.

Parameters

pRegion	Region object.
mode	Region operation mode.

Returns: HRESULT indicating success or failure.

◆ Release()

long IRenderTarget::Release ( )

Decrement the reference count and destroy the object if the count reaches zero.

Returns: New reference count.

◆ ReleaseDC()

void IRenderTarget::ReleaseDC	(	HDC	hdc,
		LPCRECT	pRc = NULL )

Releases a previously retrieved device context (DC).

Parameters

hdc	Handle to the device context to release.
pRc	Optional pointer to a rectangle defining the area to update (default is NULL).

◆ Resize()

HRESULT IRenderTarget::Resize ( SIZE sz )

Resize the render target.

Parameters

sz New size.

Returns: HRESULT indicating success or failure.

◆ RestoreClip()

HRESULT IRenderTarget::RestoreClip ( int nState = -1 )

Restore a previously saved clip state.

Parameters

nState Clip state identifier. If -1, restores the last saved state.

Returns: HRESULT indicating success or failure.

◆ SaveClip()

HRESULT IRenderTarget::SaveClip ( int * pnState )

Save the current clip state.

Parameters

pnState Pointer to receive the clip state identifier.

Returns: HRESULT indicating success or failure.

◆ SelectDefaultObject()

HRESULT IRenderTarget::SelectDefaultObject	(	OBJTYPE	objType,
		IRenderObj **	pOldObj = NULL )

Resets the specified rendering object to its default state.

Parameters

objType	Type of the rendering object to reset.
pOldObj	Optional pointer to receive the previous object (default is NULL).

Returns: HRESULT indicating success or failure.

◆ SelectObject()

HRESULT IRenderTarget::SelectObject	(	IRenderObj *	pObj,
		IRenderObj **	pOldObj = NULL )

Selects a new rendering object and optionally retrieves the previous one.

Parameters

pObj	Pointer to the new rendering object.
pOldObj	Optional pointer to receive the previous object (default is NULL).

Returns: HRESULT indicating success or failure.

◆ SetAntiAlias()

BOOL IRenderTarget::SetAntiAlias ( BOOL bAntiAlias )

Enables or disables anti-aliasing for drawing operations.

Parameters

bAntiAlias Boolean indicating whether anti-aliasing should be enabled.

Returns: BOOL indicating the previous anti-aliasing state.

◆ SetMaskFilter()

void IRenderTarget::SetMaskFilter ( IMaskFilter * pMaskFilter )

Sets the mask filter for anti-aliasing effects.

Parameters

pMaskFilter Pointer to the mask filter object.

◆ SetPixel()

COLORREF IRenderTarget::SetPixel	(	int	x,
		int	y,
		COLORREF	cr )

Sets the color of a specific pixel.

Parameters

x	X-coordinate of the pixel.
y	Y-coordinate of the pixel.
cr	New color for the pixel.

Returns: COLORREF representing the previous color of the pixel.

◆ SetTextColor()

COLORREF IRenderTarget::SetTextColor ( COLORREF color )

Sets the current text color.

Parameters

color New text color.

Returns: COLORREF representing the previous text color.

◆ SetTransform()

HRESULT IRenderTarget::SetTransform	(	const float	matrix[9],
		float	oldMatrix[9] = NULL )

Sets the coordinate transformation matrix.

Parameters

matrix	Array of 9 floats representing the new 3x3 transformation matrix.
oldMatrix	Optional array of 9 floats to store the previous transformation matrix (default is NULL).

Returns: HRESULT indicating success or failure.

◆ SetViewportOrg()

HRESULT IRenderTarget::SetViewportOrg ( POINT pt )

Set the viewport origin.

Parameters

pt	New viewport origin.

Returns: HRESULT indicating success or failure.

◆ SetXfermode()

HRESULT IRenderTarget::SetXfermode	(	int	mode,
		int *	pOldMode = NULL )

Sets the transfer mode for drawing operations.

Parameters

mode	New transfer mode.
pOldMode	Optional pointer to store the previous transfer mode (default is NULL).

Returns: HRESULT indicating success or failure.

◆ TextOut()

HRESULT IRenderTarget::TextOut	(	int	x,
		int	y,
		LPCTSTR	lpszString,
		int	nCount )

Output text at a specified position.

Parameters

x	X-coordinate of the text position.
y	Y-coordinate of the text position.
lpszString	Text to output.
nCount	Number of characters to output.

Returns: HRESULT indicating success or failure.

The documentation for this struct was generated from the following file:

SOUI/include/interface/SRender-i.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddRef()

◆ AlphaBlend()

◆ BitBlt()

◆ ClearRect()

◆ CreateBitmapBrush()

◆ CreateGradientBrush()

◆ CreatePen()

◆ CreateRegion()

◆ CreateSolidColorBrush()

◆ DrawArc()

◆ DrawArc2()

◆ DrawBitmap()

◆ DrawBitmap9Patch()

◆ DrawBitmapEx()

◆ DrawEllipse()

◆ DrawGradientPath()

◆ DrawGradientRect()

◆ DrawGradientRectEx()

◆ DrawIconEx()

◆ DrawLines()

◆ DrawPath()

◆ DrawRectangle()

◆ DrawRoundRect()

◆ DrawText()

◆ ExcludeClipRect()

◆ FillArc()

◆ FillEllipse()

◆ FillPath()

◆ FillRectangle()

◆ FillRoundRect()

◆ FillSolidEllipse()

◆ FillSolidRect()

◆ FillSolidRoundRect()

◆ GetAntiAlias()

◆ GetClipBox()

◆ GetClipRegion()

◆ GetCurrentObject()

◆ GetDC()

◆ GetMaskFilter()

◆ GetPixel()

◆ GetTextColor()

◆ GetTransform()

◆ GetViewportOrg()

◆ InvertRect()

◆ IsOffscreen()

◆ MeasureText()

◆ OffsetViewportOrg()

◆ PopClip()

◆ PushClipPath()

◆ PushClipRect()

◆ PushClipRegion()

◆ Release()

◆ ReleaseDC()

◆ Resize()

◆ RestoreClip()

◆ SaveClip()

◆ SelectDefaultObject()

◆ SelectObject()

◆ SetAntiAlias()

◆ SetMaskFilter()

◆ SetPixel()

◆ SetTextColor()

◆ SetTransform()

◆ SetViewportOrg()

◆ SetXfermode()

◆ TextOut()