You.i Engine
Public Member Functions | Static Public Member Functions | List of all members
CYIAssetConfigurationDataSource Class Referenceabstract
Assets

Detailed Description

Represents a data source for asset configuration.

This class is used to provide a (configurable) means by which screen and surface configuration can be accessed by an asset configuration. By default, the asset configuration data source queries surface and screen configuration directly from the system's surface and screen.

See also
CYIAbstractAssetConfiguration

#include <asset/YiAssetConfigurationDataSource.h>

Public Member Functions

virtual ~CYIAssetConfigurationDataSource ()
 
virtual const CYIScreen * GetCustomScreen () const =0
 
virtual int16_t GetCustomSurfaceWidth () const =0
 
virtual int16_t GetCustomSurfaceHeight () const =0
 

Static Public Member Functions

static void SetCustomInstance (CYIAssetConfigurationDataSource *pInstance)
 Sets a custom asset configuration data source. If a custom data source instance has already been assigned, it will be deleted. Call with nullptr to remove a custom data source instance. More...
 
static const CYIScreen * GetScreen ()
 Gets the screen configuration from the current screen. If a data source instance has been assigned, the screen configuration is fetched from it instead. More...
 
static int16_t GetSurfaceWidth ()
 Gets the surface width from the current surface. If a data source instance has been assigned, the surface width is fetched from it instead. More...
 
static int16_t GetSurfaceHeight ()
 Gets the surface height from the current surface. If a data source instance has been assigned, the surface height is fetched from it instead. More...
 

Constructor & Destructor Documentation

virtual CYIAssetConfigurationDataSource::~CYIAssetConfigurationDataSource ( )
virtual

Member Function Documentation

virtual const CYIScreen* CYIAssetConfigurationDataSource::GetCustomScreen ( ) const
pure virtual
virtual int16_t CYIAssetConfigurationDataSource::GetCustomSurfaceHeight ( ) const
pure virtual
virtual int16_t CYIAssetConfigurationDataSource::GetCustomSurfaceWidth ( ) const
pure virtual
static const CYIScreen* CYIAssetConfigurationDataSource::GetScreen ( )
static

Gets the screen configuration from the current screen. If a data source instance has been assigned, the screen configuration is fetched from it instead.

static int16_t CYIAssetConfigurationDataSource::GetSurfaceHeight ( )
static

Gets the surface height from the current surface. If a data source instance has been assigned, the surface height is fetched from it instead.

static int16_t CYIAssetConfigurationDataSource::GetSurfaceWidth ( )
static

Gets the surface width from the current surface. If a data source instance has been assigned, the surface width is fetched from it instead.

static void CYIAssetConfigurationDataSource::SetCustomInstance ( CYIAssetConfigurationDataSource *  pInstance)
static

Sets a custom asset configuration data source. If a custom data source instance has already been assigned, it will be deleted. Call with nullptr to remove a custom data source instance.

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