Keyframes Layers trueSKY Actor

Select your engine:

namespace plugin

Include: Plugins/TrueSkyPluginRender/PluginTrueSkyRenderer.h

Classes and Structures

struct ExternalTexture  
struct Query  
class TrackingAllocator  

Functions

simul::sky::uid GetCloudLayerUIDByIndex(int index)
simul::sky::uid GetInterpolatedCloudKeyframeUniqueId(int layer)
simul::sky::uid GetInterpolatedSkyKeyframeUniqueId()
int GetNumStorms()
simul::sky::uid GetStormAtTime(float t)
simul::sky::uid GetStormByIndex(int i)
bool StaticAddWaterBuoyancyObject(simul::terrain::WaterMeshObjectValues newObject)
bool StaticAddWaterMaskObject(simul::terrain::waterMaskingObject newObject)
bool StaticAddWaterParticleGenerator(simul::terrain::particleGeneratorValues newGenerator, simul::terrain::particleGeneratorType newGeneratorType, simul::plugin::ExternalTexture customPlaneTexture)
bool StaticAddWaterProbe(simul::terrain::WaterProbeValues values)
void StaticCloudLineQuery(int id, float startpos, float endpos, LineQueryResult res)
void StaticCloudPointQuery(int id, float pos, VolumeQueryResult res)
int StaticCopySkylight(void pContext, int cube_id, float shValues, int shOrder, void targetTex, mat4 engineToSimulMatrix4x4, int updateFrequency, float blend, float copy_exposure, float copy_gamma)
int StaticCopySkylight2(void pContext, int cube_id, float shValues, int shOrder, void targetTex, mat4 engineToSimulMatrix4x4, int updateFrequency, float blend, float copy_exposure, float copy_gamma, vec3 ground_colour)
bool StaticCreateBoundedWaterObject(int ID, float dimension, float location)
bool StaticCreateCustomWaterMesh(int ID, simul::terrain::WaterMeshObjectValues newMesh, vec3 vertices, vec3 normals, uint indices)
void StaticEnableLogging(char logfile)
void StaticExecuteDeferredRendering()
void StaticExportCloudLayerToGeometry(char filenameUtf8, int index)
bool StaticFillColourTable(simul::sky::uid uid, int x, int y, int z, float target)
int StaticGet(long long num, simul::base::Variant v)
long long StaticGetEnum(char name)
void * StaticGetEnvironment()
float StaticGetFloatAtPosition(long long enum_, float pos, int uid)
int StaticGetLightningBolts(simul::clouds::ExportLightningStrike s, int maxnum)
int StaticGetOrAddView(void ident)
int StaticGetRender(char name, int numparams, simul::base::Variant params)
bool StaticGetRenderBool(char name)
float StaticGetRenderFloat(char name)
float StaticGetRenderFloatAtPosition(char name, float pos)
int StaticGetRenderInt(char name, int numparams, simul::base::Variant params)
simul::plugin::PluginTrueSkyRenderer * StaticGetRenderInterfaceInstance()
int StaticGetRenderString(char name, char str, int len)
bool StaticGetWaterBool(char name, int ID)
float * StaticGetWaterBuoyancyObjectResults(int ID)
float StaticGetWaterFloat(char name, int ID)
int StaticGetWaterInt(char name, int ID)
void StaticGetWaterProbeValues(int ID, vec4 values)
bool StaticGetWaterVector(char name, int ID, float)
bool StaticHasRenderFloat(char name)
bool StaticHasRenderInt(char name)
int StaticInitInterface()
void StaticLightingQuery(int id, float pos, LightingQueryResult res)
int StaticOnDeviceChanged(void device)
void StaticPopPath(char type)
int StaticProbeSkylight(void pContext, int cube_id, int mip_size, int face_index, int x, int y, int w, int h, float targetValues)
void StaticProcessQueries(int num, simul::plugin::Query queries)
void StaticPushPath(char type, char value)
void StaticRemoveBoundedWaterObject(int ID)
void StaticRemoveCustomWaterMesh(int ID)
void StaticRemoveView(int view_id)
void StaticRemoveWaterBuoyancyObject(int ID)
void StaticRemoveWaterMaskObject(int ID)
void StaticRemoveWaterParticleGenerator(int ID)
void StaticRemoveWaterProbe(int ID)
simul::sky::uid StaticRenderCreateCloudKeyframer(char name)
simul::sky::uid StaticRenderDeleteCloudKeyframer(simul::sky::uid uid)
void StaticRenderDeleteKeyframe(simul::sky::uid uid)
int StaticRenderFrame(void device, void pContext, int view_id, float viewMatrix4x4, float projMatrix4x4, void depthTexture, void colourTarget, simul::crossplatform::Viewport depthViewports, simul::crossplatform::Viewport viewports, simul::plugin::RenderStyle s, float exposure, float gamma, int framenumber, simul::crossplatform::MultiResConstants pMultiResConstants)
simul::sky::uid StaticRenderGetKeyframeByIndex(int layer, int index)
int StaticRenderGetNumKeyframes(int layer)
simul::sky::uid StaticRenderInsertKeyframe(int layer, float t)
bool StaticRenderKeyframeGetBool(simul::sky::uid uid, char name)
float StaticRenderKeyframeGetFloat(simul::sky::uid uid, char name)
int StaticRenderKeyframeGetInt(simul::sky::uid uid, char name)
bool StaticRenderKeyframeHasBool(simul::sky::uid uid, char name)
bool StaticRenderKeyframeHasFloat(simul::sky::uid uid, char name)
bool StaticRenderKeyframeHasInt(simul::sky::uid uid, char name)
float StaticRenderKeyframerGetFloat(simul::sky::uid uid, char name)
int StaticRenderKeyframerGetInt(simul::sky::uid uid, char name)
void StaticRenderKeyframerSetFloat(simul::sky::uid uid, char name, float value)
void StaticRenderKeyframerSetInt(simul::sky::uid uid, char name, int value)
void StaticRenderKeyframeSetBool(simul::sky::uid uid, char name, bool value)
void StaticRenderKeyframeSetFloat(simul::sky::uid uid, char name, float value)
void StaticRenderKeyframeSetInt(simul::sky::uid uid, char name, int value)
void StaticRenderOverlays(void device, void pContext, void externalDepthTexture, float viewMatrix4x4, float projMatrix4x4, int view_id, void colourTarget, simul::crossplatform::Viewport viewports)
int StaticSet(long long num, simul::base::Variant v)
void StaticSetCloudKeyframePosition(simul::sky::uid uid, float LatLongHeadingDeg)
void StaticSetDebugOutputCallback(DebugOutputCallback)
int StaticSetExternalDynamicValues(simul::plugin::ExternalDynamicValues D)
int StaticSetExternalRenderValues(simul::plugin::ExternalRenderValues C)
void StaticSetGraphicsDevice(void device, simul::crossplatform::RenderPlatformType deviceType, UnityGfxDeviceEventType eventType)
void StaticSetGraphicsDeviceAndContext(void device, void context, simul::crossplatform::RenderPlatformType deviceType, UnityGfxDeviceEventType eventType)
void StaticSetKeyframerMapTexture(simul::sky::uid uid, char PNGName)
void StaticSetMatrix4x4(char name, float matrix4x4)
void StaticSetMemoryInterface(simul::base::MemoryInterface)
void StaticSetPointLight(int id, pos, float min_radius, float max_radius, irradiance)
void StaticSetRender(char name, int num_params, simul::base::Variant params)
void StaticSetRenderBool(char name, bool value)
void StaticSetRenderFloat(char name, float value)
void StaticSetRenderInt(char name, int value)
void StaticSetRenderString(char name, char value)
int StaticSetRenderTexture(char name, void texturePtr)
int StaticSetSequence(std::string SequenceInput)
int StaticSetSequence2(char txt)
int StaticSetSequenceTxt(char txt)
void StaticSetWaterBool(char name, int ID, bool value)
void StaticSetWaterFloat(char name, int ID, float value)
void StaticSetWaterInt(char name, int ID, int value)
void StaticSetWaterVector(char name, int ID, float value)
int StaticShutDownInterface()
int StaticSpawnLightning(startpos, endpos, float magnitude, colour)
bool StaticTriggerAction(char name)
void StaticUpdateCustomWaterMesh(int ID, simul::terrain::WaterMeshObjectValues newMesh)
void StaticUpdateWaterBuoyancyObjectValues(simul::terrain::WaterMeshObjectValues values)
void StaticUpdateWaterMaskObjectValues(simul::terrain::waterMaskingObject values)
void StaticUpdateWaterParticleGeneratorValues(simul::terrain::particleGeneratorValues values, simul::terrain::particleGeneratorType generatorType, simul::plugin::ExternalTexture customPlaneTexture)
void StaticUpdateWaterProbeValues(simul::terrain::WaterProbeValues values)
int StaticWaterSet(long long num, int ID, simul::base::Variant v)
void UnitySetGraphicsDevice(void device, simul::crossplatform::RenderPlatformType deviceType, UnityGfxDeviceEventType eventType)

Functions

simul::sky::uid GetCloudLayerUIDByIndex(int index)

Get the UID of a Cloud Layer by Index (Starting at 0)

simul::sky::uid GetInterpolatedCloudKeyframeUniqueId(int layer)

Get the ID of the current interpolated cloud keyframe on the given layer

simul::sky::uid GetInterpolatedSkyKeyframeUniqueId()

Get the ID of the current interpolated sky keyframe

int GetNumStorms()

Get the total number of storms

simul::sky::uid GetStormAtTime(float t)

Get a storm ID, if it exists, at time t

simul::sky::uid GetStormByIndex(int i)

Get a storm ID with index i

bool StaticAddWaterBuoyancyObject(simul::terrain::WaterMeshObjectValues newObject)

Create a water buoyancy object with a given struct that holds an array of vertices

bool StaticAddWaterMaskObject(simul::terrain::waterMaskingObject newObject)

Create a water masking object

bool StaticAddWaterParticleGenerator(simul::terrain::particleGeneratorValues newGenerator, simul::terrain::particleGeneratorType newGeneratorType, simul::plugin::ExternalTexture customPlaneTexture)

Create a particle generator

bool StaticAddWaterProbe(simul::terrain::WaterProbeValues values)

Create a water probe

void StaticCloudLineQuery(int id, float startpos, float endpos, LineQueryResult res)

Perform a query of the cloud properties along a given vector in world space

void StaticCloudPointQuery(int id, float pos, VolumeQueryResult res)

Perform a query of the cloud properties at a given point in world space

int StaticCopySkylight(void pContext, int cube_id, float shValues, int shOrder, void targetTex, mat4 engineToSimulMatrix4x4, int updateFrequency, float blend, float copy_exposure, float copy_gamma)

(DEPRECATED) Update a skylight cubemap, and return the latest result.

int StaticCopySkylight2(void pContext, int cube_id, float shValues, int shOrder, void targetTex, mat4 engineToSimulMatrix4x4, int updateFrequency, float blend, float copy_exposure, float copy_gamma, vec3 ground_colour)

(DEPRECATED) Update a skylight cubemap, and return the latest result.

bool StaticCreateBoundedWaterObject(int ID, float dimension, float location)

Create a bounded water object with a given ID

bool StaticCreateCustomWaterMesh(int ID, simul::terrain::WaterMeshObjectValues newMesh, vec3 vertices, vec3 normals, uint indices)

Add a custom mesh to the given Bounded water object

void StaticEnableLogging(char logfile)

Pass a specific char pointer to write log output to.

void StaticExecuteDeferredRendering()

Render all the deferred contexts.

void StaticExportCloudLayerToGeometry(char filenameUtf8, int index)

Exports the cloud layer as geometry

bool StaticFillColourTable(simul::sky::uid uid, int x, int y, int z, float target)

Set the current atmosphric scattering colour to a constant colour

int StaticGet(long long num, simul::base::Variant v)

Get thevalue corresponding to the given enum.

long long StaticGetEnum(char name)

Get the enum of a specific value

void * StaticGetEnvironment()

Returns the simul::clouds::Environment pointer.

float StaticGetFloatAtPosition(long long enum_, float pos, int uid)

Get a float value at a specific point within worldspace (enum version)

int StaticGetLightningBolts(simul::clouds::ExportLightningStrike s, int maxnum)

Get the properties of a lightning bolt that is currently active in the scene

int StaticGetOrAddView(void ident)

Ensure that a view is created, unique to the ident that was passed. So this ident must be unique to each of the active views in the external engine. Return — The trueSKY id for that view.

int StaticGetRender(char name, int numparams, simul::base::Variant params)

(DEPRECATED) Get an int value.

bool StaticGetRenderBool(char name)

Get a string value.

float StaticGetRenderFloat(char name)

Get a float value.

float StaticGetRenderFloatAtPosition(char name, float pos)

Get a float value at a specific point within worldspace

int StaticGetRenderInt(char name, int numparams, simul::base::Variant params)

Get an int value.

simul::plugin::PluginTrueSkyRenderer * StaticGetRenderInterfaceInstance()

Get a pointer to the plugin renderer

int StaticGetRenderString(char name, char str, int len)

Get a string value.

bool StaticGetWaterBool(char name, int ID)

Get a bool for a specfic water object

float * StaticGetWaterBuoyancyObjectResults(int ID)

Get the results of a water buoyancy object

float StaticGetWaterFloat(char name, int ID)

Get a float for a specfic water object

int StaticGetWaterInt(char name, int ID)

Get an int for a specfic water object

void StaticGetWaterProbeValues(int ID, vec4 values)

Get the results of a water probe

bool StaticGetWaterVector(char name, int ID, float)

Get a vector for a specfic water object

bool StaticHasRenderFloat(char name)

Check if this version of trueSky has a given float value

bool StaticHasRenderInt(char name)

Check if this version of trueSky has a given int value

int StaticInitInterface()

Ensure that the renderer is initialized. Subsequent calls have no effect.

void StaticLightingQuery(int id, float pos, LightingQueryResult res)

Perform a query of the atmosphric light properties at a given point in world space

int StaticOnDeviceChanged(void device)

Assign the platform GPU device pointer.

void StaticPopPath(char type)

Pop a path from a stack, either “TexturePath”, or “ShaderPath”.

int StaticProbeSkylight(void pContext, int cube_id, int mip_size, int face_index, int x, int y, int w, int h, float targetValues)

Probe a rectangular area of a skylight cubemap.

void StaticProcessQueries(int num, simul::plugin::Query queries)

Process currently active queries

void StaticPushPath(char type, char value)

Push a path for trueSKY to use. Must be “TexturePath”, “ShaderPath”, or “ShaderBinaryPath”. The latter is not a stack.

void StaticRemoveBoundedWaterObject(int ID)

Remove a bounded water object with a given ID

void StaticRemoveCustomWaterMesh(int ID)

Remove a custom mesh from the given Bounded water object

void StaticRemoveView(int view_id)

Free up the specified view and its resources.

void StaticRemoveWaterBuoyancyObject(int ID)

Remove a water buoyancy object

void StaticRemoveWaterMaskObject(int ID)

Remove a water masking object

void StaticRemoveWaterParticleGenerator(int ID)

Remove a particle generator

void StaticRemoveWaterProbe(int ID)

Remove a water probe

simul::sky::uid StaticRenderCreateCloudKeyframer(char name)

Create a new Cloud Keyframer

simul::sky::uid StaticRenderDeleteCloudKeyframer(simul::sky::uid uid)

Delete a Cloud Keyframer

void StaticRenderDeleteKeyframe(simul::sky::uid uid)

Delete a keyframe with ID uid

int StaticRenderFrame(void device, void pContext, int view_id, float viewMatrix4x4, float projMatrix4x4, void depthTexture, void colourTarget, simul::crossplatform::Viewport depthViewports, simul::crossplatform::Viewport viewports, simul::plugin::RenderStyle s, float exposure, float gamma, int framenumber, simul::crossplatform::MultiResConstants pMultiResConstants)

(DEPRECATED)Render trueSKY to the current render target.

simul::sky::uid StaticRenderGetKeyframeByIndex(int layer, int index)

Get a cloud keyframe on a given layer by index

int StaticRenderGetNumKeyframes(int layer)

Get the number of keyframes on a given layer

simul::sky::uid StaticRenderInsertKeyframe(int layer, float t)

Insert a keyframe on a layer at time t

bool StaticRenderKeyframeGetBool(simul::sky::uid uid, char name)

Get a bool value for a given keyframe

float StaticRenderKeyframeGetFloat(simul::sky::uid uid, char name)

Get a float value for a given keyframe

int StaticRenderKeyframeGetInt(simul::sky::uid uid, char name)

Get an int value for a given keyframe

bool StaticRenderKeyframeHasBool(simul::sky::uid uid, char name)

Has the keyframe with the given ID got the given bool value

bool StaticRenderKeyframeHasFloat(simul::sky::uid uid, char name)

Has the keyframe with the given ID got the given float value

bool StaticRenderKeyframeHasInt(simul::sky::uid uid, char name)

Has the keyframe with the given ID got the given int value

float StaticRenderKeyframerGetFloat(simul::sky::uid uid, char name)

Get a float value for a given Layer

int StaticRenderKeyframerGetInt(simul::sky::uid uid, char name)

Get an int value for a given Layer

void StaticRenderKeyframerSetFloat(simul::sky::uid uid, char name, float value)

Set a float value for a given Layer

void StaticRenderKeyframerSetInt(simul::sky::uid uid, char name, int value)

Set an int value for a given Layer

void StaticRenderKeyframeSetBool(simul::sky::uid uid, char name, bool value)

Set a bool value for a given keyframe

void StaticRenderKeyframeSetFloat(simul::sky::uid uid, char name, float value)

Set a float value for a given keyframe

void StaticRenderKeyframeSetInt(simul::sky::uid uid, char name, int value)

Set an int value for a given keyframe

void StaticRenderOverlays(void device, void pContext, void externalDepthTexture, float viewMatrix4x4, float projMatrix4x4, int view_id, void colourTarget, simul::crossplatform::Viewport viewports)

Render the debug overlays.

int StaticSet(long long num, simul::base::Variant v)

Set the value corresponding to the given enum.

void StaticSetCloudKeyframePosition(simul::sky::uid uid, float LatLongHeadingDeg)

Set the position of the Cloud Keyframe

void StaticSetDebugOutputCallback(DebugOutputCallback)

Provide a function that trueSKY can use to output debug warnings, information, and errors.

int StaticSetExternalDynamicValues(simul::plugin::ExternalDynamicValues D)

Set all values that can be changed at runtime

int StaticSetExternalRenderValues(simul::plugin::ExternalRenderValues C)

Set all values that are not recommened to update at runtime

void StaticSetGraphicsDevice(void device, simul::crossplatform::RenderPlatformType deviceType, UnityGfxDeviceEventType eventType)

Device event handler.

void StaticSetGraphicsDeviceAndContext(void device, void context, simul::crossplatform::RenderPlatformType deviceType, UnityGfxDeviceEventType eventType)

Device event handler.

void StaticSetKeyframerMapTexture(simul::sky::uid uid, char PNGName)

Set the map texture of a CLoud Keyframer

void StaticSetMatrix4x4(char name, float matrix4x4)

Set a Matrix value.

void StaticSetMemoryInterface(simul::base::MemoryInterface)

Provide memory allocator for CPU and (on some platforms) GPU memory.

void StaticSetPointLight(int id, pos, float min_radius, float max_radius, irradiance)

Create a light source at a given point in worldspace

void StaticSetRender(char name, int num_params, simul::base::Variant params)

(DEPRECATED) Set an int value.

void StaticSetRenderBool(char name, bool value)

Set a bool value.

void StaticSetRenderFloat(char name, float value)

Set a float value.

void StaticSetRenderInt(char name, int value)

(DEPRECATED) Set an int value.

void StaticSetRenderString(char name, char value)

Set a string value.

int StaticSetRenderTexture(char name, void texturePtr)

Set a texture for truesky to render to. Need to define the valid name of the output.

int StaticSetSequence(std::string SequenceInput)

Loads the sequence as a std::string.

int StaticSetSequence2(char txt)

Loads the sequence as a c string.

int StaticSetSequenceTxt(char txt)

Loads the given sequence

void StaticSetWaterBool(char name, int ID, bool value)

Set a bool for a specfic water object

void StaticSetWaterFloat(char name, int ID, float value)

Set a float for a specfic water object

void StaticSetWaterInt(char name, int ID, int value)

Set an int for a specfic water object

void StaticSetWaterVector(char name, int ID, float value)

Set a vector for a specfic water object

int StaticShutDownInterface()

Shut down the renderer and free all resources.

int StaticSpawnLightning(startpos, endpos, float magnitude, colour)

Spawn a lightning strike at a given start, endpoint, magnitude and colour

bool StaticTriggerAction(char name)

Trigger an action.

void StaticUpdateCustomWaterMesh(int ID, simul::terrain::WaterMeshObjectValues newMesh)

Update a custom mesh to the given Bounded water object

void StaticUpdateWaterBuoyancyObjectValues(simul::terrain::WaterMeshObjectValues values)

Update the properties of a water buoyancy object

void StaticUpdateWaterMaskObjectValues(simul::terrain::waterMaskingObject values)

Update the values of a specific water buoyancy object

void StaticUpdateWaterParticleGeneratorValues(simul::terrain::particleGeneratorValues values, simul::terrain::particleGeneratorType generatorType, simul::plugin::ExternalTexture customPlaneTexture)

Update the values of a specific water particle generator

void StaticUpdateWaterProbeValues(simul::terrain::WaterProbeValues values)

Update the properties of a water object

int StaticWaterSet(long long num, int ID, simul::base::Variant v)

Set the water value corresponding to the given enum.

void UnitySetGraphicsDevice(void device, simul::crossplatform::RenderPlatformType deviceType, UnityGfxDeviceEventType eventType)

Unity-specific device event. Calls StaticSetGraphicsDevice() if needed.

Enums

RenderStyle Different rendering styles