class UISection

File location: framework/cauldron/framework/inc/core/uimanager.h

Construction

Return type

Description

UISection (uint64_t id, const char* name, UISectionType type)
Constructor. Creates the UI section.

Methods

Return type

Description

template <typename T, typename… U> T*

RegisterUIElement (U&&… u)
Create and registers a “UIElement“.

template <typename T> void

RegisterUIElement (T&& element)
Registers an existed “UIElement“.

template <typename T, typename… U> T*

RegisterUIElementWithPriority (uint32_t priority, U&&… u)
Create and registers a “UIElement“ with priority.

template <typename T, typename… U> T*

CreateUIElement (U&&… u)
Create a “UIElement“.

template <typename T, typename… U> T*

CreateUIElementWithPriority (uint32_t priority, U&&… u)
Create a “UIElement“ with priority.

template <typename T> bool

UnregisterUIElement (T&& element)
Unregisters an existed “UIElement“. This will make the “UIElement“ stop rendering.

const char*

Get the section description.

const std::map<uint64_t, UIElement *>&

GetElements () const
Get the “UIElement“ s in this section.

uint64_t

ID () const
Get the ID of this section. ID represents the priority, lower ID means higher priority.

bool

Shown () const
Check the section is shown.

void

Show (bool show)
Show or hide the element.

void

Release UISection.

Detailed description

Construction

UISection

Copied!

UISection (uint64_t id, const char* name, UISectionType  type)

Constructor. Creates the UI section.


Methods

RegisterUIElement

Copied!

template <typename T, typename... U>    T* RegisterUIElement (U&&... u)

Create and registers a UIElement.


RegisterUIElement

Copied!

template <typename T>   void RegisterUIElement (T&& element)

Registers an existed UIElement.


RegisterUIElementWithPriority

Copied!

template <typename T, typename... U>    T* RegisterUIElementWithPriority (
    uint32_t priority,
    U&&... u
)

Create and registers a UIElement with priority.


CreateUIElement

Copied!

template <typename T, typename... U>    T* CreateUIElement (U&&... u)

Create a UIElement.


CreateUIElementWithPriority

Copied!

template <typename T, typename... U>    T* CreateUIElementWithPriority (
    uint32_t priority,
    U&&... u
)

Create a UIElement with priority.


UnregisterUIElement

Copied!

template <typename T>   bool UnregisterUIElement (T&& element)

Unregisters an existed UIElement. This will make the UIElement stop rendering.


GetSectionName

Copied!

const char* GetSectionName () const

Get the section description.


GetElements

Copied!

const std::map<uint64_t, UIElement *>& GetElements () const

Get the UIElement s in this section.


ID

Copied!

uint64_t ID () const

Get the ID of this section. ID represents the priority, lower ID means higher priority.


Shown

Copied!

bool Shown () const

Check the section is shown.


Show

Copied!

void Show (bool show)

Show or hide the element.


Release

Copied!

void Release ()

Release UISection.


Related pages

  • Visit the FidelityFX SDK product page for download links and more information.

Looking for more documentation on GPUOpen?

AMD GPUOpen software blogs

Our handy software release blogs will help you make good use of our tools, SDKs, and effects, as well as sharing the latest features with new releases.

GPUOpen Manuals

Don’t miss our manual documentation! And if slide decks are what you’re after, you’ll find 100+ of our finest presentations here.

AMD GPUOpen Performance Guides

The home of great performance and optimization advice for AMD RDNAâ„¢ 2 GPUs, AMD Ryzenâ„¢ CPUs, and so much more.

Getting started: AMD GPUOpen software

New or fairly new to AMD’s tools, libraries, and effects? This is the best place to get started on GPUOpen!

AMD GPUOpen Getting Started Development and Performance

Looking for tips on getting started with developing and/or optimizing your game, whether on AMD hardware or generally? We’ve got you covered!

AMD GPUOpen Technical blogs

Browse our technical blogs, and find valuable advice on developing with AMD hardware, ray tracing, Vulkan®, DirectX®, Unreal Engine, and lots more.

Find out more about our software!

AMD GPUOpen Effects - AMD FidelityFX technologies

Create wonder. No black boxes. Meet the AMD FidelityFX SDK!

AMD GPUOpen Samples

Browse all our useful samples. Perfect for when you’re needing to get started, want to integrate one of our libraries, and much more.

AMD GPUOpen developer SDKs

Discover what our SDK technologies can offer you. Query hardware or software, manage memory, create rendering applications or machine learning, and much more!

AMD GPUOpen Developer Tools

Analyze, Optimize, Profile, Benchmark. We provide you with the developer tools you need to make sure your game is the best it can be!