HPL3/Amnesia: Rebirth/Scripting/cPostEffect ScreenMaterial

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

Fields

cPostEffect_ScreenMaterial has no public fields.

Functions

Return Type	Function And Description
void	Clear()
void	CreateScreenMaterial(int alID, const tString &in asMaterial, const cVector2f &in avPos, const cVector2f &in avSize, float afAlpha, float afDepth)
void	DestroyScreenMaterial(int alID)
bool	IsActive()
bool	IsDisabled()
void	Reset()
void	SetActive(bool abX)
void	SetDisabled(bool abX)
void	SetScreenMaterialAlpha(int alID, float afAlpha)

Details

Clear

void Clear()

Returns:

• void

CreateScreenMaterial

void CreateScreenMaterial(int alID,
                          const tString &in asMaterial,
                          const cVector2f &in avPos,
                          const cVector2f &in avSize,
                          float afAlpha,
                          float afDepth)

Parameters

• alID (int) —
• asMaterial (tString) —
• avPos (cVector2f) —
• avSize (cVector2f) —
• afAlpha (float) —
• afDepth (float) —

Returns:

• void

DestroyScreenMaterial

void DestroyScreenMaterial(int alID)

Parameters

• alID (int) —

Returns:

• void

IsActive

bool IsActive()

Returns:

• bool—

IsDisabled

bool IsDisabled()

Returns:

• bool—

Reset

void Reset()

Returns:

• void

SetActive

void SetActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetDisabled

void SetDisabled(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetScreenMaterialAlpha

void SetScreenMaterialAlpha(int alID,
                            float afAlpha)

Parameters

• alID (int) —
• afAlpha (float) —

Returns:

• void

References

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

See all references...