SCRIPTING API / Rendering and effects / Camera

Camera

Script access to an entity's Camera: field of view, clip planes and whether it is the active camera.

Kindclass

NamespaceKroys.EngineScripting

Members9

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

Component access: every member takes the entity first, for example Camera.Has(Entity). The values are the ones the Inspector shows for this component.

Declaration

public static partial class Camera

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Camera component.

methodstatic

#public static bool IsPrimary(Entity e)

Reads the Camera component's Primary value of the entity.

methodstatic

#public static void SetPrimary(Entity e, bool value)

Sets the Camera component's Primary value on the entity.

methodstatic

#public static float GetFov(Entity e)

Reads the Camera component's Fov value of the entity.

methodstatic

#public static void SetFov(Entity e, float value)

Sets the Camera component's Fov value on the entity.

methodstatic

#public static float GetNearClip(Entity e)

Reads the Camera component's Near Clip value of the entity.

methodstatic

#public static void SetNearClip(Entity e, float value)

Sets the Camera component's Near Clip value on the entity.

methodstatic

#public static float GetFarClip(Entity e)

Reads the Camera component's Far Clip value of the entity.

methodstatic

#public static void SetFarClip(Entity e, float value)

Sets the Camera component's Far Clip value on the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static bool IsPrimary(Entity e)
public static void SetPrimary(Entity e, bool value)
public static float GetFov(Entity e)
public static void SetFov(Entity e, float value)
public static float GetNearClip(Entity e)
public static void SetNearClip(Entity e, float value)
public static float GetFarClip(Entity e)
public static void SetFarClip(Entity e, float value)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.