HPL3/Amnesia: Rebirth/Scripting/cViewport

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cViewport has no public fields.

Functions

Return Type	Function And Description
void	AddGuiSet(cGuiSet@ apSet)
void	AddRendererCallback(iRendererCallback@ apCallback)
void	AddViewportCallback(iViewportCallback@ apCallback)
cCamera	GetCamera()
iFrameBuffer	GetFrameBuffer()
cVector2l	GetPosition()
cPostEffectComposite	GetPostEffectComposite()
iRenderer	GetRenderer()
cRenderSettings	GetRenderSettings()
cVector2l	GetSize()
cPostEffect_ToneMapping	GetToneMappingEffect()
cWorld	GetWorld()
bool	IsActive()
bool	IsListener()
bool	IsVisible()
void	RemoveGuiSet(cGuiSet@ apSet)
void	RemoveRendererCallback(iRendererCallback@ apCallback)
void	RemoveViewportCallback(iViewportCallback@ apCallback)
void	SetActive(bool abX)
void	SetCamera(cCamera@ apCamera)
void	SetFrameBuffer(iFrameBuffer@ apFrameBuffer)
void	SetIsListener(bool abX)
void	SetPosition(const cVector2l &in avPos)
void	SetPostEffectComposite(cPostEffectComposite@ apPostEffectComposite)
void	SetRenderer(iRenderer@ apRenderer)
void	SetSize(const cVector2l &in avSize)
void	SetVisible(bool abX)
void	SetWorld(cWorld@ apWorld, bool abResetEffects = false)

Details

AddGuiSet

void AddGuiSet(cGuiSet@ apSet)

Parameters

• apSet (cGuiSet@) —

Returns:

• void

AddRendererCallback

void AddRendererCallback(iRendererCallback@ apCallback)

Parameters

• apCallback (iRendererCallback@) —

Returns:

• void

AddViewportCallback

void AddViewportCallback(iViewportCallback@ apCallback)

Parameters

• apCallback (iViewportCallback@) —

Returns:

• void

GetCamera

cCamera@ GetCamera()

Returns:

• cCamera@—

GetFrameBuffer

iFrameBuffer@ GetFrameBuffer()

Returns:

• iFrameBuffer@—

GetPosition

const cVector2l& GetPosition()

Returns:

• const cVector2l&—

GetPostEffectComposite

cPostEffectComposite@ GetPostEffectComposite()

Returns:

• cPostEffectComposite@—

GetRenderer

iRenderer@ GetRenderer()

Returns:

• iRenderer@—

GetRenderSettings

cRenderSettings@ GetRenderSettings()

Returns:

• cRenderSettings@—

GetSize

const cVector2l& GetSize()

Returns:

• const cVector2l&—

GetToneMappingEffect

cPostEffect_ToneMapping@ GetToneMappingEffect()

Returns:

• cPostEffect_ToneMapping@—

GetWorld

cWorld@ GetWorld()

Returns:

• cWorld@—

IsActive

bool IsActive()

Returns:

• bool—

IsListener

bool IsListener()

Returns:

• bool—

IsVisible

bool IsVisible()

Returns:

• bool—

RemoveGuiSet

void RemoveGuiSet(cGuiSet@ apSet)

Parameters

• apSet (cGuiSet@) —

Returns:

• void

RemoveRendererCallback

void RemoveRendererCallback(iRendererCallback@ apCallback)

Parameters

• apCallback (iRendererCallback@) —

Returns:

• void

RemoveViewportCallback

void RemoveViewportCallback(iViewportCallback@ apCallback)

Parameters

• apCallback (iViewportCallback@) —

Returns:

• void

SetActive

void SetActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetCamera

void SetCamera(cCamera@ apCamera)

Parameters

• apCamera (cCamera@) —

Returns:

• void

SetFrameBuffer

void SetFrameBuffer(iFrameBuffer@ apFrameBuffer)

Parameters

• apFrameBuffer (iFrameBuffer@) —

Returns:

• void

SetIsListener

void SetIsListener(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetPosition

void SetPosition(const cVector2l &in avPos)

Parameters

• avPos (cVector2l) —

Returns:

• void

SetPostEffectComposite

void SetPostEffectComposite(cPostEffectComposite@ apPostEffectComposite)

Parameters

• apPostEffectComposite (cPostEffectComposite@) —

Returns:

• void

SetRenderer

void SetRenderer(iRenderer@ apRenderer)

Parameters

• apRenderer (iRenderer@) —

Returns:

• void

SetSize

void SetSize(const cVector2l &in avSize)

Parameters

• avSize (cVector2l) —

Returns:

• void

SetVisible

void SetVisible(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetWorld

void SetWorld(cWorld@ apWorld,
              bool abResetEffects = false)

Parameters

• apWorld (cWorld@) —
• abResetEffects (bool) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cScene ‎ (← links)

See all references...