docs/ui__scroll_8h_source.html

#pragma once


#include <glm/glm.hpp>


#include "core/reflect.h"


namespace Vkm::Engine {


struct UIScroll {

    glm::vec2 offset = {0.0f, 0.0f};


    float wheelStep = 60.0f;


    glm::vec2 contentSize = {0.0f, 0.0f};


    glm::vec2 viewSize = {0.0f, 0.0f};


    glm::vec2 range() const { return glm::max(contentSize - viewSize, glm::vec2(0.0f)); }

};


} // namespace Vkm::Engine


VKM_REFLECT_BEGIN(::Vkm::Engine::UIScroll)

    VKM_F(offset)

    VKM_F(wheelStep)

VKM_REFLECT_END()

Vkm::Engine::UIScroll
Makes an element's children scroll inside it, and clips them to it.
Definition ui_scroll.h:18

Vkm::Engine::UIScroll::wheelStep
float wheelStep
Reference pixels the content moves per wheel notch.
Definition ui_scroll.h:27

Vkm::Engine::UIScroll::viewSize
glm::vec2 viewSize
This element's resolved size, in reference pixels.
Definition ui_scroll.h:37

Vkm::Engine::UIScroll::range
glm::vec2 range() const
How far the content can travel on each axis, never negative; offset's clamp.
Definition ui_scroll.h:44

Vkm::Engine::UIScroll::offset
glm::vec2 offset
How far the content has scrolled, in canvas reference pixels.
Definition ui_scroll.h:24

Vkm::Engine::UIScroll::contentSize
glm::vec2 contentSize
Extent of the content laid out inside, in reference pixels; resolved, not authored.
Definition ui_scroll.h:34