Sinespace Client  2023.2.17543
Client-side scripting for Sinespace
SineSpace.Scripting.Components.SCamera Class Reference
Inheritance diagram for SineSpace.Scripting.Components.SCamera:
ScriptClassComponent< Camera >

Public Member Functions

void TakePhoto (Closure onSnapshotWinHide=null)
 Triggers the Photo window in the UI, with the output of this camera. Perfect for photo booths. More...
 
SResource TakeSnapshot ()
 Captures a texture from the camera, and saves it in a SResource More...
 

Properties

bool HDR [get, set]
 Can this camera write HDR values? (i.e. values brighter than 1.0) More...
 
int PixelWidth [get]
 The width of this Camera's texture, in pixels More...
 
int PixelHeight [get]
 The height of this Camera's texture in pixels More...
 
SVector Velocity [get]
 World space speed of this camera, typically used for motion blur. More...
 
bool UseOcclusionCulling [get, set]
 Is Occlusion Culling enabled on this camera? More...
 
bool Enabled [get, set]
 Is this camera enabled? More...
 
float FieldOfView [get, set]
 The field of view of the camera, in typical scenarios, Sinespace uses a value of 52; however Unity will default to 60. More...
 
bool Orthographic [get, set]
 Does this camera render without perspective? More...
 
float OrthographicSize [get, set]
 The width of the camera when in Orthographic mode. Height will be adjusted based on aspect ratio of the Render Texture More...
 
float NearClip [get, set]
 How close can an object be to the camera plane before it is not rendered? More...
 
float FarClip [get, set]
 How far is an object from the camera plane before it is not rendered? More...
 
- Properties inherited from ScriptClassComponent< Camera >
SGameObject GameObject [get]
 Return the GameObject which component added. More...
 

Member Function Documentation

◆ TakePhoto()

void SineSpace.Scripting.Components.SCamera.TakePhoto ( Closure  onSnapshotWinHide = null)

Triggers the Photo window in the UI, with the output of this camera. Perfect for photo booths.

◆ TakeSnapshot()

SResource SineSpace.Scripting.Components.SCamera.TakeSnapshot ( )

Captures a texture from the camera, and saves it in a SResource

Returns

Property Documentation

◆ Enabled

bool SineSpace.Scripting.Components.SCamera.Enabled
getset

Is this camera enabled?

◆ FarClip

float SineSpace.Scripting.Components.SCamera.FarClip
getset

How far is an object from the camera plane before it is not rendered?

◆ FieldOfView

float SineSpace.Scripting.Components.SCamera.FieldOfView
getset

The field of view of the camera, in typical scenarios, Sinespace uses a value of 52; however Unity will default to 60.

◆ HDR

bool SineSpace.Scripting.Components.SCamera.HDR
getset

Can this camera write HDR values? (i.e. values brighter than 1.0)

◆ NearClip

float SineSpace.Scripting.Components.SCamera.NearClip
getset

How close can an object be to the camera plane before it is not rendered?

◆ Orthographic

bool SineSpace.Scripting.Components.SCamera.Orthographic
getset

Does this camera render without perspective?

◆ OrthographicSize

float SineSpace.Scripting.Components.SCamera.OrthographicSize
getset

The width of the camera when in Orthographic mode. Height will be adjusted based on aspect ratio of the Render Texture

◆ PixelHeight

int SineSpace.Scripting.Components.SCamera.PixelHeight
get

The height of this Camera's texture in pixels

◆ PixelWidth

int SineSpace.Scripting.Components.SCamera.PixelWidth
get

The width of this Camera's texture, in pixels

◆ UseOcclusionCulling

bool SineSpace.Scripting.Components.SCamera.UseOcclusionCulling
getset

Is Occlusion Culling enabled on this camera?

◆ Velocity

SVector SineSpace.Scripting.Components.SCamera.Velocity
get

World space speed of this camera, typically used for motion blur.