Coherent UI  2.5.3
A modern user interface library for games
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
Coherent::UI::ViewInfo Struct Reference

Encapsulates the options of a View. More...

#include <Coherent/UI/ViewInfo.h>

Public Attributes

int Width
 The Width of a View in pixels.
 
int Height
 The Height of a View in pixels.
 
bool UsesSharedMemory
 Flags if a View uses shared memory for the rendering data transport or shared textures. Shared memory is much slower and should be used only on systems that have no support for shared textures (ex. Win XP, Linux)
 
bool SupportClickThrough
 Defines if the view should support click-through queries. Not supporting click-through increases performance slightly.
 
float ClickThroughAlphaThreshold
 The alpha threshold for click-through queries.
 
bool IsTransparent
 Defines if a view is transparent or not. A transparent view can be have transparent parts that will be correctly blended with the client's surfaces. Non-transparent views are always implicitly composited as if on a white background. Don't use transparent views unless you have transparent parts in the page because non-transparent view are slightly faster. More...
 
int TargetFrameRate
 The frame-rate of the view will never exceed the target set here. It will also never exceed the rate at which the Context Update is called. (available only in Full versions of Coherent UI)
 
bool IsOnDemand
 Defines if a view is an on-demand view. On-demand views require explicit frame requests. (available only in Full versions of Coherent UI)
 
bool ControlTimeOnDemand
 Defines if the client controls the time of on-demand views himself. If not Coherent UI will update the timers in View::RequestFrame. This option allows to have perfect time-sync for animation, js etc. between the game and the UI. (option valid for on-demand view only) (available only in Full versions of Coherent UI)
 
bool ForceSoftwareRendering
 Forces the view to use software rendering. If the application is GPU-bound pure software Views might be a good choice. CSS 3D transforms, WebGL and accelerated Canvas don't work with software Views. Software Views are incompatible with the OnDemand option and work only with shared memory surfaces.
 

Detailed Description

Encapsulates the options of a View.

Member Data Documentation

bool Coherent::UI::ViewInfo::IsTransparent

Defines if a view is transparent or not. A transparent view can be have transparent parts that will be correctly blended with the client's surfaces. Non-transparent views are always implicitly composited as if on a white background. Don't use transparent views unless you have transparent parts in the page because non-transparent view are slightly faster.

Note
Do not blend non-transparent views.
Transparent Views are not supported in the Coherent In-Game Browser product