Open 3D Engine AzFramework API Reference  2305.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
AzFramework::WindowRequests Class Referenceabstract

#include <WindowBus.h>

Inherits EBusTraits.

Public Types

using BusIdType = NativeWindowHandle
 

Public Member Functions

virtual void SetWindowTitle (const AZStd::string &title)=0
 For platforms that support it, set the title of the window.
 
virtual WindowSize GetClientAreaSize () const =0
 
virtual void ResizeClientArea (WindowSize clientAreaSize, const WindowPosOptions &options)=0
 
virtual bool SupportsClientAreaResize () const =0
 
virtual bool GetFullScreenState () const =0
 
virtual void SetFullScreenState (bool fullScreenState)=0
 
virtual bool CanToggleFullScreenState () const =0
 
virtual void ToggleFullScreenState ()=0
 Toggle the full screen state of the window.
 
virtual float GetDpiScaleFactor () const =0
 
virtual uint32_t GetSyncInterval () const =0
 Returns the sync interval which tells the drivers the number of v-blanks to synchronize with.
 
virtual bool SetSyncInterval (uint32_t newSyncInterval)=0
 
virtual uint32_t GetDisplayRefreshRate () const =0
 Returns the refresh rate of the main display.
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 

Detailed Description

Bus for sending requests to any kind of window. It could be a NativeWindow or an Editor window.

Member Function Documentation

virtual bool AzFramework::WindowRequests::CanToggleFullScreenState ( ) const
pure virtual

Can the full screen state of the window be changed/toggled?

Returns
True if the window can enter/exit full screen, false otherwise.
virtual WindowSize AzFramework::WindowRequests::GetClientAreaSize ( ) const
pure virtual

Get the client area size. This is the size that can be rendered to. On some platforms this may not be the correct size until Activate is called.

virtual float AzFramework::WindowRequests::GetDpiScaleFactor ( ) const
pure virtual

Returns a scalar multiplier representing how many dots-per-inch this window has, compared to a "standard" value of 96, the default for Windows in a DPI unaware setting. This can be used to scale user interface elements to ensure legibility on high density displays.

virtual bool AzFramework::WindowRequests::GetFullScreenState ( ) const
pure virtual

Get the full screen state of the window.

Returns
True if the window is currently in full screen, false otherwise.
virtual void AzFramework::WindowRequests::ResizeClientArea ( WindowSize  clientAreaSize,
const WindowPosOptions &  options 
)
pure virtual

Set the client area size. This is the size that can be rendered to.

Parameters
[in]clientAreaSizeSize of the client area in pixels
[in]optionsOptions for resizing and moving the window.
virtual void AzFramework::WindowRequests::SetFullScreenState ( bool  fullScreenState)
pure virtual

Set the full screen state of the window.

Parameters
[in]fullScreenStateThe full screen state to set.
virtual bool AzFramework::WindowRequests::SetSyncInterval ( uint32_t  newSyncInterval)
pure virtual

Sets the sync interval which tells the drivers the number of v-blanks to synchronize with Returns if the sync interval was successfully set

virtual bool AzFramework::WindowRequests::SupportsClientAreaResize ( ) const
pure virtual

Does this platform support window resizing. Generally desktop platforms support resizing, mobile platforms don't.

The documentation for this class was generated from the following file: