#include <OpenGUI_Brush_Caching.h>
Inheritance diagram for OpenGUI::Brush_Caching:
Public Member Functions | |
| Brush_Caching (Screen *parentScreen, const FVector2 &size) | |
| Constructor requires a pointer to the Screen that this Brush will eventually be drawn to. | |
| virtual | ~Brush_Caching () |
| Destructor. | |
| void | emerge (Brush &targetBrush) |
| sends the contents of this caching Brush into the output stream of the given Brush | |
| virtual const FVector2 & | getPPU_Raw () const |
| Returns the raw (uncorrected) PPU (pixels per unit) of this Brush. | |
| virtual const FVector2 & | getUPI_Raw () const |
| Returns the raw (uncorrected) UPI (units per inch) of this Brush. | |
| virtual bool | isRTTContext () const |
| returns true if the brush context is a render to texture surface | |
| bool | isRTT () const |
returns true if this caching Brush is using a render texture for storage | |
| bool | isMemory () const |
returns true if this caching Brush is using memory for storage | |
| void | clear () |
| public access to Brush::_clear() | |
| bool | hasContent () const |
returns true if there is content stored that can be emerged | |
Protected Member Functions | |
| virtual void | appendRenderOperation (RenderOperation &renderOp) |
| Final output RenderOperations are passed to this function. | |
| virtual void | onActivate () |
| Called automatically when this Brush becomes the active Brush. | |
| virtual void | onClear () |
| Called when this Brush has been told to clear the contents of its render surface. | |
| OpenGUI::Brush_Caching::~Brush_Caching | ( | ) | [virtual] |
Destructor.
| void OpenGUI::Brush_Caching::appendRenderOperation | ( | RenderOperation & | renderOp | ) | [protected, virtual] |
Final output RenderOperations are passed to this function.
It is up to specialized Brush implementations to capture final output with this function. At this point, the Brush is guaranteed to already to be active.
Reimplemented from OpenGUI::Brush.
| void OpenGUI::Brush_Caching::clear | ( | ) | [inline] |
public access to Brush::_clear()
| void OpenGUI::Brush_Caching::emerge | ( | Brush & | targetBrush | ) |
| const FVector2 & OpenGUI::Brush_Caching::getPPU_Raw | ( | ) | const [virtual] |
Returns the raw (uncorrected) PPU (pixels per unit) of this Brush.
Implements OpenGUI::Brush.
| const FVector2 & OpenGUI::Brush_Caching::getUPI_Raw | ( | ) | const [virtual] |
Returns the raw (uncorrected) UPI (units per inch) of this Brush.
Implements OpenGUI::Brush.
| bool OpenGUI::Brush_Caching::hasContent | ( | ) | const [inline] |
returns true if there is content stored that can be emerged
| bool OpenGUI::Brush_Caching::isMemory | ( | ) | const [inline] |
returns true if this caching Brush is using memory for storage
| bool OpenGUI::Brush_Caching::isRTT | ( | ) | const [inline] |
returns true if this caching Brush is using a render texture for storage
| virtual bool OpenGUI::Brush_Caching::isRTTContext | ( | ) | const [inline, virtual] |
| void OpenGUI::Brush_Caching::onActivate | ( | ) | [protected, virtual] |
| void OpenGUI::Brush_Caching::onClear | ( | ) | [protected, virtual] |
Called when this Brush has been told to clear the contents of its render surface.
The Brush is guaranteed to be active at this point
Implements OpenGUI::Brush.