HPL3/SOMA/Scripting/Scripting Api/cGraphics

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

Summary

Return Type	Function and Description
iDepthStencilBuffer	cGraphics_CreateDepthStencilBuffer(const cVector2l &in avSize, int alDepthBits, int alStencilBits, bool abLookForMatchingFirst)
iFrameBuffer	cGraphics_CreateFrameBuffer(const tString &in asName)
iGpuProgram	cGraphics_CreateGpuProgram(const tString &in asName)
iGpuProgram	cGraphics_CreateGpuProgramFromShaders(const tString &in asName, const tString &in asVtxShader, const tString &in asFragShader, cPrepParserVarContainer @apVarContainer)
cHeightMap	cGraphics_CreateHeightMap()
cHeightMap	cGraphics_CreateHeightMapResizedCopy(cHeightMap @apHeightMap, const cVector2l &in avSize)
cPostEffect_ChromaticAberration	cGraphics_CreatePostEffect_ChromaticAberration()
cPostEffect_ImageFadeFX	cGraphics_CreatePostEffect_ImageFadeFX()
cPostEffect_ImageTrail	cGraphics_CreatePostEffect_ImageTrail()
cPostEffect_RadialBlur	cGraphics_CreatePostEffect_RadialBlur()
cPostEffect_ToneMapping	cGraphics_CreatePostEffect_ToneMapping()
cPostEffect_VideoDistortion	cGraphics_CreatePostEffect_VideoDistortion()
cPostEffectComposite	cGraphics_CreatePostEffectComposite()
iTexture	cGraphics_CreateTexture(const tString &in asName, eTextureType aType, eTextureUsage aUsage)
void	cGraphics_DestoroyDepthStencilBuffer(iDepthStencilBuffer@ apBuffer)
void	cGraphics_DestroyFrameBuffer(iFrameBuffer@ apFrameBuffer)
void	cGraphics_DestroyGpuProgram(iGpuProgram@ apProgram)
void	cGraphics_DestroyHeightMap(cHeightMap@ apHeightMap)
void	cGraphics_DestroyPostEffect(iPostEffect@ apPostEffect)
void	cGraphics_DestroyPostEffectComposite(cPostEffectComposite@ apComposite)
void	cGraphics_DestroyTexture(iTexture@ apTexture)
iDepthStencilBuffer	cGraphics_FindDepthStencilBuffer(const cVector2l &in avSize, int alMinDepthBits, int alMinStencilBits)
iLowLevelGraphics	cGraphics_GetLowLevel()
iMaterialType	cGraphics_GetMaterialType(const tString &in asName)
iRenderer	cGraphics_GetRenderer(eRenderer aType)
iFrameBuffer	cGraphics_GetTempFrameBuffer(const cVector2l &in avSize, ePixelFormat aPixelFormat, int alIndex)
cHeightMap	cGraphics_LoadHeightMapPackedRGB(const tString &in asFileName)
cHeightMap	cGraphics_LoadHeightMapRaw(const tString &in asFileName, const cVector2l &in avSize)
void	cGraphics_ReloadMaterials()
void	cGraphics_ReloadRendererData()

Function Detail

cGraphics_CreateDepthStencilBuffer

iDepthStencilBuffer@ cGraphics_CreateDepthStencilBuffer(const cVector2l &in avSize,
                                                        int alDepthBits,
                                                        int alStencilBits,
                                                        bool abLookForMatchingFirst)

Parameters

• avSize (cVector2l) —
• alDepthBits (int) —
• alStencilBits (int) —
• abLookForMatchingFirst (bool) —

Returns:

• iDepthStencilBuffer@—

cGraphics_CreateFrameBuffer

iFrameBuffer@ cGraphics_CreateFrameBuffer(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iFrameBuffer@—

cGraphics_CreateGpuProgram

iGpuProgram@ cGraphics_CreateGpuProgram(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iGpuProgram@—

cGraphics_CreateGpuProgramFromShaders

iGpuProgram@ cGraphics_CreateGpuProgramFromShaders(const tString &in asName,
                                                   const tString &in asVtxShader,
                                                   const tString &in asFragShader,
                                                   cPrepParserVarContainer @apVarContainer)

Parameters

• asName (tString) —
• asVtxShader (tString) —
• asFragShader (tString) —
• @apVarContainer (cPrepParserVarContainer) —

Returns:

• iGpuProgram@—

cGraphics_CreateHeightMap

cHeightMap@ cGraphics_CreateHeightMap()

Returns:

• cHeightMap@—

cGraphics_CreateHeightMapResizedCopy

cHeightMap@ cGraphics_CreateHeightMapResizedCopy(cHeightMap @apHeightMap,
                                                 const cVector2l &in avSize)

Parameters

• @apHeightMap (cHeightMap) —
• avSize (cVector2l) —

Returns:

• cHeightMap@—

cGraphics_CreatePostEffect_ChromaticAberration

cPostEffect_ChromaticAberration@ cGraphics_CreatePostEffect_ChromaticAberration()

Returns:

• cPostEffect_ChromaticAberration@—

cGraphics_CreatePostEffect_ImageFadeFX

cPostEffect_ImageFadeFX@ cGraphics_CreatePostEffect_ImageFadeFX()

Returns:

• cPostEffect_ImageFadeFX@—

cGraphics_CreatePostEffect_ImageTrail

cPostEffect_ImageTrail@ cGraphics_CreatePostEffect_ImageTrail()

Returns:

• cPostEffect_ImageTrail@—

cGraphics_CreatePostEffect_RadialBlur

cPostEffect_RadialBlur@ cGraphics_CreatePostEffect_RadialBlur()

Returns:

• cPostEffect_RadialBlur@—

cGraphics_CreatePostEffect_ToneMapping

cPostEffect_ToneMapping@ cGraphics_CreatePostEffect_ToneMapping()

Returns:

• cPostEffect_ToneMapping@—

cGraphics_CreatePostEffect_VideoDistortion

cPostEffect_VideoDistortion@ cGraphics_CreatePostEffect_VideoDistortion()

Returns:

• cPostEffect_VideoDistortion@—

cGraphics_CreatePostEffectComposite

cPostEffectComposite@ cGraphics_CreatePostEffectComposite()

Returns:

• cPostEffectComposite@—

cGraphics_CreateTexture

iTexture@ cGraphics_CreateTexture(const tString &in asName,
                                  eTextureType aType,
                                  eTextureUsage aUsage)

Parameters

• asName (tString) —
• aType (eTextureType) —
• aUsage (eTextureUsage) —

Returns:

• iTexture@—

cGraphics_DestoroyDepthStencilBuffer

void cGraphics_DestoroyDepthStencilBuffer(iDepthStencilBuffer@ apBuffer)

Parameters

• apBuffer (iDepthStencilBuffer@) —

Returns:

• void

cGraphics_DestroyFrameBuffer

void cGraphics_DestroyFrameBuffer(iFrameBuffer@ apFrameBuffer)

Parameters

• apFrameBuffer (iFrameBuffer@) —

Returns:

• void

cGraphics_DestroyGpuProgram

void cGraphics_DestroyGpuProgram(iGpuProgram@ apProgram)

Parameters

• apProgram (iGpuProgram@) —

Returns:

• void

cGraphics_DestroyHeightMap

void cGraphics_DestroyHeightMap(cHeightMap@ apHeightMap)

Parameters

• apHeightMap (cHeightMap@) —

Returns:

• void

cGraphics_DestroyPostEffect

void cGraphics_DestroyPostEffect(iPostEffect@ apPostEffect)

Parameters

• apPostEffect (iPostEffect@) —

Returns:

• void

cGraphics_DestroyPostEffectComposite

void cGraphics_DestroyPostEffectComposite(cPostEffectComposite@ apComposite)

Parameters

• apComposite (cPostEffectComposite@) —

Returns:

• void

cGraphics_DestroyTexture

void cGraphics_DestroyTexture(iTexture@ apTexture)

Parameters

• apTexture (iTexture@) —

Returns:

• void

cGraphics_FindDepthStencilBuffer

iDepthStencilBuffer@ cGraphics_FindDepthStencilBuffer(const cVector2l &in avSize,
                                                      int alMinDepthBits,
                                                      int alMinStencilBits)

Parameters

• avSize (cVector2l) —
• alMinDepthBits (int) —
• alMinStencilBits (int) —

Returns:

• iDepthStencilBuffer@—

cGraphics_GetLowLevel

iLowLevelGraphics@ cGraphics_GetLowLevel()

Returns:

• iLowLevelGraphics@—

cGraphics_GetMaterialType

iMaterialType@ cGraphics_GetMaterialType(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iMaterialType@—

cGraphics_GetRenderer

iRenderer@ cGraphics_GetRenderer(eRenderer aType)

Parameters

• aType (eRenderer) —

Returns:

• iRenderer@—

cGraphics_GetTempFrameBuffer

iFrameBuffer@ cGraphics_GetTempFrameBuffer(const cVector2l &in avSize,
                                           ePixelFormat aPixelFormat,
                                           int alIndex)

Parameters

• avSize (cVector2l) —
• aPixelFormat (ePixelFormat) —
• alIndex (int) —

Returns:

• iFrameBuffer@—

cGraphics_LoadHeightMapPackedRGB

cHeightMap@ cGraphics_LoadHeightMapPackedRGB(const tString &in asFileName)

Parameters

• asFileName (tString) —

Returns:

• cHeightMap@—

cGraphics_LoadHeightMapRaw

cHeightMap@ cGraphics_LoadHeightMapRaw(const tString &in asFileName,
                                       const cVector2l &in avSize)

Parameters

• asFileName (tString) —
• avSize (cVector2l) —

Returns:

• cHeightMap@—

cGraphics_ReloadMaterials

void cGraphics_ReloadMaterials()

Returns:

• void

cGraphics_ReloadRendererData

void cGraphics_ReloadRendererData()

Returns:

• void