Bottle 2D - Lua API 1.0.0
All you need to create games using bottle2D.
Public Member Functions | Public Attributes

ScreenRenderer Class Reference

A screen renderer is used to draw the content of an other screen in the current screen. More...

#include <header.hpp>

Inheritance diagram for ScreenRenderer:
Drawable Object

List of all members.

Public Member Functions

nil SetTargetScreen (ProtectedPtr< Screen > targetScreen)
 Set the target screen.
ProtectedPtr< ScreenGetTargetScreen ()
 Get the target screen.
ScreenConfig GetScreenConfig ()
 Get the target screen config : this screen config will be used to render the target screen.
nil SetScreenConfig (ScreenConfig screenConfig)
 Set the target screen config and enable it : this screen config will be used to render the target screen.
bool IsScreenConfigEnabled ()
 Return true if the target screen use a special screenConfig (set with SetScreenConfig()), false otherwise.
nil EnableScreenConfig (bool isScreenConfigEnabled)
 Enable or disable the screenConfig.

Public Attributes

Screen targetScreen
 Access drawed screen.
ScreenConfig screenConfig
 Access target screen config.
bool isScreenConfigEnabled
 True if the target screen use a special screenConfig (set with SetScreenConfig()), false otherwise.

Detailed Description

A screen renderer is used to draw the content of an other screen in the current screen.

It can be usefull if you want to draw the content of your game in the menu background, for example. This object is created using Group::CreateScreenRenderer.


Member Function Documentation

nil ScreenRenderer::EnableScreenConfig ( bool  isScreenConfigEnabled)

Enable or disable the screenConfig.

If it is diabled, the screen will be rendered with its own screen config.

ScreenConfig ScreenRenderer::GetScreenConfig ( )

Get the target screen config : this screen config will be used to render the target screen.

ProtectedPtr<Screen> ScreenRenderer::GetTargetScreen ( )

Get the target screen.

bool ScreenRenderer::IsScreenConfigEnabled ( )

Return true if the target screen use a special screenConfig (set with SetScreenConfig()), false otherwise.

nil ScreenRenderer::SetScreenConfig ( ScreenConfig  screenConfig)

Set the target screen config and enable it : this screen config will be used to render the target screen.

nil ScreenRenderer::SetTargetScreen ( ProtectedPtr< Screen targetScreen)

Set the target screen.


Member Data Documentation

True if the target screen use a special screenConfig (set with SetScreenConfig()), false otherwise.

Access target screen config.

Access drawed screen.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables