Graphics::Brush Class Reference

The source of colour for drawing. More...

#include <Asset.h>

Inheritance diagram for Graphics::Brush:
Collaboration diagram for Graphics::Brush:

Public Types

enum  Kind : uint8_t { Kind::XX }
 

Public Member Functions

 Brush ()
 
 Brush (Color color)
 
 Brush (const Brush &other)
 
 Brush (const Brush &other, PixelFormat format)
 
 Brush (PackedColor color)
 
 Brush (const TextureBrush *brush)
 
void setColor (Color color)
 
void setPixelFormat (PixelFormat format)
 
Kind getKind () const
 
 operator bool () const
 
bool isSolid () const
 
bool isTransparent () const
 
bool operator== (Color color) const
 
bool operator!= (Color color) const
 
bool operator== (const Brush &other) const
 
bool operator!= (const Brush &other) const
 
Color getColor () const
 
PackedColor getPackedColor () const
 
PackedColor getPackedColor (PixelFormat format) const
 
PackedColor getPackedColor (Point pt) const
 
const TextureBrushgetObject () const
 
bool setPixel (Surface &surface, const Location &loc) const
 
uint16_t setPixels (Surface &surface, const Location &loc, uint16_t pixelCount) const
 
uint16_t writePixel (const Location &loc, void *buffer) const
 
uint16_t writePixels (const Location &loc, void *buffer, uint16_t pixelCount) const
 
String getTypeStr () const
 
void write (MetaWriter &meta) const
 

Detailed Description

The source of colour for drawing.

Member Enumeration Documentation

◆ Kind

Enumerator
XX 

Constructor & Destructor Documentation

◆ Brush() [1/6]

Graphics::Brush::Brush ( )
inline

◆ Brush() [2/6]

Graphics::Brush::Brush ( Color  color)
inline

◆ Brush() [3/6]

Graphics::Brush::Brush ( const Brush other)
inline

◆ Brush() [4/6]

Graphics::Brush::Brush ( const Brush other,
PixelFormat  format 
)
inline

◆ Brush() [5/6]

Graphics::Brush::Brush ( PackedColor  color)
inline

◆ Brush() [6/6]

Graphics::Brush::Brush ( const TextureBrush brush)
inline

Member Function Documentation

◆ getColor()

Color Graphics::Brush::getColor ( ) const
inline

◆ getKind()

Kind Graphics::Brush::getKind ( ) const
inline

◆ getObject()

const TextureBrush& Graphics::Brush::getObject ( ) const
inline

◆ getPackedColor() [1/3]

PackedColor Graphics::Brush::getPackedColor ( ) const
inline

◆ getPackedColor() [2/3]

PackedColor Graphics::Brush::getPackedColor ( PixelFormat  format) const

◆ getPackedColor() [3/3]

PackedColor Graphics::Brush::getPackedColor ( Point  pt) const

◆ getTypeStr()

String Graphics::Brush::getTypeStr ( ) const

◆ isSolid()

bool Graphics::Brush::isSolid ( ) const
inline

◆ isTransparent()

bool Graphics::Brush::isTransparent ( ) const
inline

◆ operator bool()

Graphics::Brush::operator bool ( ) const
inlineexplicit

◆ operator!=() [1/2]

bool Graphics::Brush::operator!= ( Color  color) const
inline

◆ operator!=() [2/2]

bool Graphics::Brush::operator!= ( const Brush other) const
inline

◆ operator==() [1/2]

bool Graphics::Brush::operator== ( Color  color) const
inline

◆ operator==() [2/2]

bool Graphics::Brush::operator== ( const Brush other) const
inline

◆ setColor()

void Graphics::Brush::setColor ( Color  color)
inline

◆ setPixel()

bool Graphics::Brush::setPixel ( Surface surface,
const Location loc 
) const

◆ setPixelFormat()

void Graphics::Brush::setPixelFormat ( PixelFormat  format)
inline

◆ setPixels()

uint16_t Graphics::Brush::setPixels ( Surface surface,
const Location loc,
uint16_t  pixelCount 
) const

◆ write()

void Graphics::Brush::write ( MetaWriter meta) const

◆ writePixel()

uint16_t Graphics::Brush::writePixel ( const Location loc,
void *  buffer 
) const

◆ writePixels()

uint16_t Graphics::Brush::writePixels ( const Location loc,
void *  buffer,
uint16_t  pixelCount 
) const

Member Data Documentation

◆ brush

const TextureBrush* Graphics::Brush::brush

◆ color

Color Graphics::Brush::color

◆ packedColor

PackedColor Graphics::Brush::packedColor

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