IBrushS Struct Reference

Brush object interface. More...

#include <SRender-i.h>

Inheritance diagram for IBrushS:

Public Member Functions
long	AddRef () PURE
	Increments the reference count for the object.
long	Release () PURE
	Decrements the reference count for the object.
void	OnFinalRelease () PURE
	Called when the final release of the object occurs.
IRenderFactory *	GetRenderFactory () SCONST PURE
	Obtains the render factory that created this rendering object.
OBJTYPE	ObjectType () SCONST PURE
	Queries the type of the rendering object.
BrushType	GetBrushType () SCONST PURE
	Queries the type of the brush.
Public Member Functions inherited from IRenderObj
long	AddRef () PURE
	Increments the reference count for the object.
long	Release () PURE
	Decrements the reference count for the object.
void	OnFinalRelease () PURE
	Called when the final release of the object occurs.
IRenderFactory *	GetRenderFactory () SCONST PURE
	Obtains the render factory that created this rendering object.
OBJTYPE	ObjectType () SCONST PURE
	Queries the type of the rendering object.
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

Brush object interface.

@describe

This interface represents a brush used for rendering operations. It inherits from the IRenderObj interface and provides methods to query the brush type and manage the brush's lifecycle.

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

Member Function Documentation

AddRef()

long IBrushS::AddRef

(

)

Increments the reference count for the object.

This method is used to increase the reference count of the object, ensuring it remains valid as long as references exist.

Returns

long The new reference count after incrementing.

GetBrushType()

BrushType IBrushS::GetBrushType

(

)

Queries the type of the brush.

Returns an enumeration value representing the type of the brush (e.g., color, bitmap, shader).

Returns

BrushType The type of the brush.

GetRenderFactory()

IRenderFactory * IBrushS::GetRenderFactory

(

)

Obtains the render factory that created this rendering object.

Retrieves a pointer to the render factory responsible for creating this object.

Returns

IRenderFactory* Pointer to the render factory.

ObjectType()

OBJTYPE IBrushS::ObjectType

(

)

Queries the type of the rendering object.

Returns an enumeration value representing the type of the object (e.g., brush, pen, bitmap).

Returns

OBJTYPE The type of the rendering object.

OnFinalRelease()

void IBrushS::OnFinalRelease

(

)

Called when the final release of the object occurs.

This method is invoked when the reference count reaches zero, allowing for any necessary cleanup before the object is destroyed.

Release()

long IBrushS::Release

(

)

Decrements the reference count for the object.

This method decreases the reference count of the object. When the count reaches zero, the object may be released.

Returns

long The new reference count after decrementing.

---

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

• SOUI/include/interface/SRender-i.h