|
| CanvasOpenGL3 (const char *typeName=StaticWidgetType, bool initRenderer=true) |
|
| CanvasOpenGL3 (const CanvasOpenGL3 ©) |
| Copy constructor.
|
|
| CanvasOpenGL3 (CanvasOpenGL3 &©)=default |
| Default move constructor.
|
|
| ~CanvasOpenGL3 () override |
| Destructor.
|
|
CanvasOpenGL3 & | operator= (const CanvasOpenGL3 &right) |
| Overload of copy assignment operator.
|
|
CanvasOpenGL3 & | operator= (CanvasOpenGL3 &&right)=default |
| Default move assignment operator.
|
|
void | setSize (const Layout2d &size) override |
| Changes the size of the widget.
|
|
void | draw (BackendRenderTarget &target, RenderStates states) const override |
| Draw the widget to a render target.
|
|
unsigned int | bindFramebuffer () const |
| Binds the framebuffer of the canvas.
|
|
void | setSize (Layout width, Layout height) |
| Changes the size of the widget.
|
|
| CanvasBase (const char *typeName, bool initRenderer) |
|
void | ignoreMouseEvents (bool ignore=true) |
| Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.
|
|
bool | isIgnoringMouseEvents () const |
| Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
|
|
bool | canGainFocus () const override |
| Returns whether the widget can gain focus.
|
|
bool | isMouseOnWidget (Vector2f pos) const override |
| Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
|
|
| ClickableWidget (const char *typeName=StaticWidgetType, bool initRenderer=true) |
|
bool | isMouseOnWidget (Vector2f pos) const override |
| Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
|
|
bool | leftMousePressed (Vector2f pos) override |
| Called by the parent when the left mouse button goes down on top of the widget.
|
|
void | leftMouseReleased (Vector2f pos) override |
|
void | rightMousePressed (Vector2f pos) override |
|
void | rightMouseReleased (Vector2f pos) override |
|
void | rightMouseButtonNoLongerDown () override |
|
void | draw (BackendRenderTarget &target, RenderStates states) const override |
| Draw the widget to a render target.
|
|
| Widget (const char *typeName, bool initRenderer) |
|
| Widget (const Widget &) |
| Copy constructor.
|
|
| Widget (Widget &&) noexcept |
| Move constructor.
|
|
virtual | ~Widget () |
| Destructor.
|
|
Widget & | operator= (const Widget &) |
| Overload of copy assignment operator.
|
|
Widget & | operator= (Widget &&) noexcept |
| Move assignment.
|
|
void | setRenderer (std::shared_ptr< RendererData > rendererData) |
| Sets a new renderer for the widget. The renderer determines how the widget looks.
|
|
virtual WidgetRenderer * | getSharedRenderer () |
| Returns the renderer, which gives access to functions that determine how the widget is displayed.
|
|
virtual const WidgetRenderer * | getSharedRenderer () const |
|
virtual WidgetRenderer * | getRenderer () |
| Returns the renderer, which gives access to functions that determine how the widget is displayed.
|
|
virtual void | setPosition (const Layout2d &position) |
| sets the position of the widget
|
|
void | setPosition (Layout x, Layout y) |
| Sets the position of the widget.
|
|
Vector2f | getPosition () const |
| Gets the position of the widget.
|
|
void | setSize (Layout width, Layout height) |
| Changes the size of the widget.
|
|
void | setWidth (Layout width) |
| Changes the width of the widget.
|
|
void | setHeight (Layout height) |
| Changes the height of the widget.
|
|
Vector2f | getSize () const |
| Returns the size of the widget.
|
|
virtual Vector2f | getFullSize () const |
| Returns the entire size that the widget is using.
|
|
virtual Vector2f | getAbsolutePosition (Vector2f offset={}) const |
| Get the absolute position of the widget instead of the relative position to its parent.
|
|
virtual Vector2f | getWidgetOffset () const |
| Returns the distance between the position where the widget is drawn and where the widget is placed.
|
|
void | setAutoLayout (AutoLayout layout) |
| Sets how the position is determined compared to the other widgets in the parent.
|
|
AutoLayout | getAutoLayout () const |
| Returns how the position is determined compared to the other widgets in the parent.
|
|
void | setOrigin (float x, float y) |
| Sets the origin point on which the position, scale and rotation is based.
|
|
void | setOrigin (Vector2f origin) |
| Sets the origin point on which the position, scale and rotation is based.
|
|
Vector2f | getOrigin () const |
| Returns the relative origin point on which the position, scale and rotation is based.
|
|
void | setScale (Vector2f scaleFactors) |
| Sets the scaling to be applied to the widget.
|
|
void | setScale (Vector2f scaleFactors, Vector2f origin) |
| Sets the scaling to be applied to the widget.
|
|
void | setScale (float scaleFactor) |
| Sets the scaling to be applied to the widget.
|
|
void | setScale (float scaleFactor, Vector2f origin) |
| Sets the scaling to be applied to the widget.
|
|
Vector2f | getScale () const |
| Returns the scaling to be applied to the widget.
|
|
Vector2f | getScaleOrigin () const |
| Returns the origin used for scaling.
|
|
void | setRotation (float angle) |
| Sets the rotation to be applied to the widget.
|
|
void | setRotation (float angle, Vector2f origin) |
| Sets the rotation to be applied to the widget.
|
|
float | getRotation () const |
| Returns the rotation to be applied to the widget.
|
|
Vector2f | getRotationOrigin () const |
| Returns the origin used for rotations.
|
|
void | showWithEffect (ShowEffectType type, Duration duration) |
| Shows the widget by introducing it with an animation.
|
|
void | hideWithEffect (ShowEffectType type, Duration duration) |
| Hides the widget by making it leave with an animation.
|
|
void | moveWithAnimation (Layout2d position, Duration duration) |
| Moves the widget from its current position to the given position, over a given duration.
|
|
void | resizeWithAnimation (Layout2d size, Duration duration) |
| Resizes the widget from its current size to the given size, over a given duration.
|
|
virtual void | setVisible (bool visible) |
| Shows or hides a widget.
|
|
bool | isVisible () const |
| Returns true when the widget is visible.
|
|
virtual void | setEnabled (bool enabled) |
| Enables or disables the widget.
|
|
bool | isEnabled () const |
| Returns true when the widget is enabled.
|
|
virtual void | setFocused (bool focused) |
| Focus or unfocus the widget.
|
|
bool | isFocused () const |
| Returns true when the widget is focused and false otherwise.
|
|
const String & | getWidgetType () const |
| Returns the type of the widget.
|
|
Container * | getParent () const |
| Returns a pointer to the parent widget.
|
|
BackendGui * | getParentGui () const |
| Returns a pointer to the gui to which this widget belongs.
|
|
bool | isAnimationPlaying () const |
| Returns whether there is an active animation (started with showWithEffect or hideWithEffect)
|
|
void | moveToFront () |
| Places the widget before all other widgets.
|
|
void | moveToBack () |
| Places the widget behind all other widgets.
|
|
void | setUserData (Any userData) |
| Stores some data into the widget.
|
|
template<typename DataType > |
DataType | getUserData () const |
| Returns data stored in the widget.
|
|
bool | hasUserData () const |
| Returns whether data stored in the widget.
|
|
void | setInheritedFont (const Font &font) |
| Sets the font of the widget that is used when no font is set in the renderer.
|
|
const Font & | getInheritedFont () const |
| Returns the font of the widget that is used when no font is set in the renderer.
|
|
void | setInheritedOpacity (float opacity) |
| Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.
|
|
float | getInheritedOpacity () const |
| Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
|
|
void | setTextSize (unsigned int size) |
| Changes the character size of text in this widget if it uses text.
|
|
unsigned int | getTextSize () const |
| Returns the character size of text in this widget.
|
|
void | setToolTip (Widget::Ptr toolTip) |
| Sets the tool tip that should be displayed when hovering over the widget.
|
|
Widget::Ptr | getToolTip () const |
| Returns the tool tip that is displayed when hovering over the widget.
|
|
void | setWidgetName (const String &name) |
| Changes the name of a widget.
|
|
String | getWidgetName () const |
| Returns the name of a widget.
|
|
void | setMouseCursor (Cursor::Type cursor) |
| Changes which mouse cursor is shown when hovering over the widget.
|
|
Cursor::Type | getMouseCursor () const |
| Returns which mouse cursor is shown when hovering over the widget.
|
|
void | setFocusable (bool focusable) |
| Changes whether a widget could be focused.
|
|
bool | isFocusable () const |
| Returns whether a widget could be focused.
|
|
void | setNavigationUp (const Widget::Ptr &widgetAbove) |
| Changes which widget should become focused when navigating upwards from this widget.
|
|
Widget::Ptr | getNavigationUp () const |
| Returns which widget would become focused when navigating upwards from this widget.
|
|
void | setNavigationDown (const Widget::Ptr &widgetBelow) |
| Changes which widget should become focused when navigating downwards from this widget.
|
|
Widget::Ptr | getNavigationDown () const |
| Returns which widget would become focused when navigating downwards from this widget.
|
|
void | setNavigationLeft (const Widget::Ptr &widgetLeft) |
| Changes which widget should become focused when navigating to the left from this widget.
|
|
Widget::Ptr | getNavigationLeft () const |
| Returns which widget would become focused when navigating to the left from this widget.
|
|
void | setNavigationRight (const Widget::Ptr &widgetRight) |
| Changes which widget should become focused when navigating to the right from this widget.
|
|
Widget::Ptr | getNavigationRight () const |
| Returns which widget would become focused when navigating to the right from this widget.
|
|
void | setIgnoreMouseEvents (bool ignore) |
| Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.
|
|
bool | getIgnoreMouseEvents () const |
| Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
|
|
void | finishAllAnimations () |
| Makes all animations of the widget finish immediately.
|
|
bool | isContainer () const |
| Returns whether the widget is a container widget or not.
|
|
bool | isMouseDown () const |
| Returns whether the left mouse button has been pressed on top of the widget.
|
|
virtual void | setParent (Container *parent) |
|
virtual bool | updateTime (Duration elapsedTime) |
|
void | setAutoLayoutUpdateEnabled (bool enabled) |
|
virtual void | mouseReleased (Event::MouseButton button, Vector2f pos) |
|
virtual void | mouseMoved (Vector2f pos) |
|
virtual void | keyPressed (const Event::KeyEvent &event) |
|
virtual bool | canHandleKeyPress (const Event::KeyEvent &event) |
| Called by the parent of the widget to check if keyPressed would process the event.
|
|
virtual void | textEntered (char32_t key) |
|
virtual bool | scrolled (float delta, Vector2f pos, bool touch) |
| Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)
|
|
virtual void | mouseNoLongerOnWidget () |
|
virtual void | leftMouseButtonNoLongerDown () |
|
virtual Widget::Ptr | askToolTip (Vector2f mousePos) |
|
const Layout2d & | getPositionLayout () const |
|
const Layout2d & | getSizeLayout () const |
|
void | bindPositionLayout (Layout *layout) |
|
void | unbindPositionLayout (Layout *layout) |
|
void | bindSizeLayout (Layout *layout) |
|
void | unbindSizeLayout (Layout *layout) |
|
template<typename WidgetType > |
std::shared_ptr< const WidgetType > | cast () const |
| Downcast const widget.
|
|
template<typename WidgetType > |
std::shared_ptr< WidgetType > | cast () |
| Downcast widget.
|
|
void | rendererChangedCallback (const String &property) |
|
virtual void | updateTextSize () |
|
CanvasOpenGL3 provides a way to directly render OpenGL contents on a widget.
When gui.draw() is called, all widgets are drawn at once. If you wish to have custom OpenGL rendering inbetween TGUI widgets (e.g. draw to the background of a child window) then you need to use a CanvasOpenGL3 widget.
The canvas widget is essentially just a wrapper around a framebuffer and its texture. You draw your OpenGL contents on top of the canvas instead of on the window. The canvas is then added to the gui between the widgets where you want the rendering to appear.
You can redraw the contents of the canvas at any time, but make sure to always start by calling bindFramebuffer and end the rendering by calling glBindFramebuffer again.
Example:
gui.add(canvas);
canvas->bindFramebuffer();
glClear(GL_COLOR_BUFFER_BIT);
glBindFramebuffer(GL_FRAMEBUFFER, 0);
static CanvasOpenGL3::Ptr create(const Layout2d &size={"100%", "100%"})
Creates a new canvas widget.