gigawidgets/image_8hpp_source.html

#pragma once


#include "core/renderable.hpp"

#include "core/widget.hpp"


namespace ui {


class Image : public Widget {

    Renderable const *renderable;

    shader_t shader;

    bool renderEveryFrame;


public:

    Image(const Renderable &renderable, const Position &pos = {0, 0}, const Alignment &align = {ALIGN_LEFT, ALIGN_TOP});


    void draw() const override;

    Size size() const override;

    void update(time_t time_ms) override;


    void setShader(const shader_animated_t &shader);


    void setShader(const shader_oneframe_t &shader);


    void removeShader();


    void setRender(const Renderable &renderable);


    DERIVE_EVENT_HANDLERS(Image)

};


} // namespace ui

ui::Image
Display an arbitrary (non-animated) renderable to the screen with an optional shader.
Definition image.hpp:12

ui::Image::draw
void draw() const override
Render the widget to the screen.

ui::Image::setShader
void setShader(const shader_oneframe_t &shader)
Set the image shader to one that only requires rendering once.

ui::Image::setRender
void setRender(const Renderable &renderable)
Change the current rendered object.

ui::Image::update
void update(time_t time_ms) override
Update any internal state of the widget, and check if it needs to be re-rendered.

ui::Image::removeShader
void removeShader()
Remove the shader from the image, if any exists.

ui::Image::size
Size size() const override
Get the size of the widget.

ui::Image::setShader
void setShader(const shader_animated_t &shader)
Set the image shader to a new one that requires re-rendering every frame.

ui::Image::Image
Image(const Renderable &renderable, const Position &pos={0, 0}, const Alignment &align={ALIGN_LEFT, ALIGN_TOP})
Construct an image from some renderable data.

ui::Widget
The common interface for all UI objects.
Definition widget.hpp:27

renderable.hpp

ui::shader_animated_t
std::function< color_t(color_t color, const Coords &coords, const Size &size, time_t time)> shader_animated_t
A pixel shader that may update based on the current time.
Definition renderable.hpp:35

ui::shader_t
shader_animated_t shader_t
A pixel shader that may or may not update based on the current time.
Definition renderable.hpp:48

ui::shader_oneframe_t
std::function< color_t(color_t color, const Coords &coords, const Size &size)> shader_oneframe_t
A pixel shader that's independent of the current time.
Definition renderable.hpp:22

ui::Alignment
A struct that holds a widget's vertical and horizontal alignment.
Definition alignment.hpp:22

ui::Position
A struct that holds the normalized position of a widget.
Definition position.hpp:15

ui::Renderable
An abstract interface for arbitrary renderable objects.
Definition renderable.hpp:55

ui::Size
A struct that holds the number of pixels that a widget would take up on the screen.
Definition size.hpp:17

widget.hpp