1.7.2.9
Gameface
cohtml::ViewSettings Struct Reference

Settings used when initializing a View. More...

Public Member Functions

 ViewSettings ()
 

Public Attributes

IViewListenerListener
 The ViewListener is notified of events happening in the View. More...
 
unsigned Width
 The Width of the View. More...
 
unsigned Height
 The Height of the View. More...
 
OnRenderingTasksAvailableFunc OnRenderingTasksAvailable
 Called when the View is completely advanced and laid-out. More...
 
OnMonotonicallyIncreasingTimeRequestFunc OnMonotonicallyIncreasingTimeRequest
 Called during the advance of the views when accurate current time is needed The client should return monotonically increasing time in milliseconds. More...
 
void * UserData
 Passed to the OnRenderingTasksAvailable and OnMonotonicallyIncreasingTimeRequest callbacks. More...
 
bool EnableComplexCSSSelectorsStyling
 Tells if to enable complex CSS selectors when doing style matching. By complex in this context we mean any CSS selector that requires walking the DOM tree to match - that is selectors with any combinator (https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors#Combinators) and selectors with pseudo-classes that depend on the tree like :nth-child(), :first etc. This flag has a performance implication. Views that don't need such selectors should leave it disabled, which makes style matching significantly faster. More...
 
bool InterceptResourceRequests
 Allows you to intercept resource requests for this view in order to restrict resource access of the view to only specified sets of urls. If InterceptResourceRequests is not explicitly set to true, the default behavior will be to allow every request. More...
 
unsigned MinimumVertexBufferSize
 Controls the mininum count of vertices allocated when creating vertex buffers. If equal to 0 then default count will be used which is 32768. More...
 
unsigned MinimumIndexBufferSize
 Controls the mininum count of indices allocated when creating index buffers. If equal to 0 then default count will be used which is 49152. More...
 
unsigned VertexIndexBufferRingSize
 Controls the size of each ring buffer (the VB ring buffer and the IB ring buffer). Every call to BeginFrame rotates the ring buffer and takes the next available buffer that the GPU should not be using. The acceptable range is between 1 and 8. More...
 
unsigned DoubleClickTime
 The double-click time is the maximum number of milliseconds that may occur between the first and second click of a double-click. More...
 
ITextInputHandlerTextInputHandler
 Notifies of changes to an input elements Can be set to nullptr if the user is not interested in receiving the events. More...
 
float StartPanThreshold
 Controls the minumum lenght of pans to be performed. More...
 
const void * DeveloperOptions
 Reserved property for internal usage. Do not use it. More...
 

Detailed Description

Settings used when initializing a View.

Constructor & Destructor Documentation

◆ ViewSettings()

cohtml::ViewSettings::ViewSettings ( )
inline

Member Data Documentation

◆ DeveloperOptions

const void* cohtml::ViewSettings::DeveloperOptions

Reserved property for internal usage. Do not use it.

◆ DoubleClickTime

unsigned cohtml::ViewSettings::DoubleClickTime

The double-click time is the maximum number of milliseconds that may occur between the first and second click of a double-click.

◆ EnableComplexCSSSelectorsStyling

bool cohtml::ViewSettings::EnableComplexCSSSelectorsStyling

Tells if to enable complex CSS selectors when doing style matching. By complex in this context we mean any CSS selector that requires walking the DOM tree to match - that is selectors with any combinator (https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors#Combinators) and selectors with pseudo-classes that depend on the tree like :nth-child(), :first etc. This flag has a performance implication. Views that don't need such selectors should leave it disabled, which makes style matching significantly faster.

◆ Height

unsigned cohtml::ViewSettings::Height

The Height of the View.

◆ InterceptResourceRequests

bool cohtml::ViewSettings::InterceptResourceRequests

Allows you to intercept resource requests for this view in order to restrict resource access of the view to only specified sets of urls. If InterceptResourceRequests is not explicitly set to true, the default behavior will be to allow every request.

◆ Listener

IViewListener* cohtml::ViewSettings::Listener

The ViewListener is notified of events happening in the View.

◆ MinimumIndexBufferSize

unsigned cohtml::ViewSettings::MinimumIndexBufferSize

Controls the mininum count of indices allocated when creating index buffers. If equal to 0 then default count will be used which is 49152.

◆ MinimumVertexBufferSize

unsigned cohtml::ViewSettings::MinimumVertexBufferSize

Controls the mininum count of vertices allocated when creating vertex buffers. If equal to 0 then default count will be used which is 32768.

◆ OnMonotonicallyIncreasingTimeRequest

OnMonotonicallyIncreasingTimeRequestFunc cohtml::ViewSettings::OnMonotonicallyIncreasingTimeRequest

Called during the advance of the views when accurate current time is needed The client should return monotonically increasing time in milliseconds.

◆ OnRenderingTasksAvailable

OnRenderingTasksAvailableFunc cohtml::ViewSettings::OnRenderingTasksAvailable

Called when the View is completely advanced and laid-out.

Note
This can be called on any thread!

◆ StartPanThreshold

float cohtml::ViewSettings::StartPanThreshold

Controls the minumum lenght of pans to be performed.

◆ TextInputHandler

ITextInputHandler* cohtml::ViewSettings::TextInputHandler

Notifies of changes to an input elements Can be set to nullptr if the user is not interested in receiving the events.

◆ UserData

void* cohtml::ViewSettings::UserData

Passed to the OnRenderingTasksAvailable and OnMonotonicallyIncreasingTimeRequest callbacks.

◆ VertexIndexBufferRingSize

unsigned cohtml::ViewSettings::VertexIndexBufferRingSize

Controls the size of each ring buffer (the VB ring buffer and the IB ring buffer). Every call to BeginFrame rotates the ring buffer and takes the next available buffer that the GPU should not be using. The acceptable range is between 1 and 8.

◆ Width

unsigned cohtml::ViewSettings::Width

The Width of the View.