TGUI  0.8-dev
tgui::PictureRenderer Class Reference
Inheritance diagram for tgui::PictureRenderer:
tgui::WidgetRenderer

Public Member Functions

void setTexture (const Texture &texture)
 Change the image that is displayed. More...
 
TexturegetTexture () const
 Returns the image that is displayed. More...
 
void setIgnoreTransparentParts (bool ignoreTransparentParts)
 Sets whether mouse events should be ignored on transparent parts of the texture. More...
 
bool getIgnoreTransparentParts () const
 Returns whether mouse events should be ignored on transparent parts of the texture. More...
 
- Public Member Functions inherited from tgui::WidgetRenderer
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. More...
 
virtual ~WidgetRenderer ()=default
 Virtual destructor.
 
void setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
void setFont (Font font)
 Changes the font used for the text in the widget. More...
 
Font getFont () const
 Returns the font associated with the widget (if any) More...
 
void setProperty (const std::string &property, ObjectConverter &&value)
 Changes a property of the renderer. More...
 
ObjectConverter getProperty (const std::string &property) const
 Retrieves the value of a certain property. More...
 
const std::map< std::string, ObjectConverter > & getPropertyValuePairs () const
 Gets a map with all properties and their values. More...
 
void subscribe (const void *id, const std::function< void(const std::string &property)> &function)
 Subscribes a callback function to changes in the renderer. More...
 
void unsubscribe (const void *id)
 Subscribes a callback function to changes in the renderer. More...
 
std::shared_ptr< RendererDatagetData () const
 Returns the renderer data. More...
 
std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data. More...
 

Member Function Documentation

◆ getIgnoreTransparentParts()

bool tgui::PictureRenderer::getIgnoreTransparentParts ( ) const

Returns whether mouse events should be ignored on transparent parts of the texture.

Whether mouse events on transparent texture parts are ignored

◆ getTexture()

Texture& tgui::PictureRenderer::getTexture ( ) const

Returns the image that is displayed.

Returns
texture of the image

◆ setIgnoreTransparentParts()

void tgui::PictureRenderer::setIgnoreTransparentParts ( bool  ignoreTransparentParts)

Sets whether mouse events should be ignored on transparent parts of the texture.

ignoreTransparentParts Should mouse events on transparent texture parts be ignored?

When mouse events are ignored, they are passed to the other widget behind the widget. By default, mouse events are NOT ignored and the widget will receive mouse events even on transparent texture parts.

◆ setTexture()

void tgui::PictureRenderer::setTexture ( const Texture texture)

Change the image that is displayed.

Parameters
textureThe new texture

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