FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kProjectorState.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_PROJECTOR_STATE_H
9 #define K_FIRESYNC_PROJECTOR_STATE_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kProjectorState; --forward-declared in kFsDef.x.h
20 
31 
41 kFsFx(kStatus) kProjectorState_SetIntensity(kProjectorState state, k32u intensity, kAdjust adjustment = kADJUST_NONE);
42 
51 
61 
73 kFsFx(kStatus) kProjectorState_SetExposureNs(kProjectorState state, k64u exposure, kAdjust adjustment = kADJUST_NONE);
74 
85 
95 
107 kFsFx(kStatus) kProjectorState_SetGapNs(kProjectorState state, k64u gap, kAdjust adjustment = kADJUST_NONE);
108 
119 
129 
139 
148 
158 
167 
176 
192 
193 #include <kFireSync/Client/kProjectorState.x.h>
194 
195 #endif
Type of adjustment to perform to bring a setting into conformance with its constraints.
#define kADJUST_NONE
No adjustment.
Definition: kInfo.h:48
kStatus kProjectorState_EnableAutoGap(kProjectorState state, kBool enabled)
Enables automatic gap calculation for the projector state.
kBool kProjectorState_AutoGapEnabled(kProjectorState state)
Reports whether automatic gap is enabled for the projector state.
kStatus kProjectorState_ExposureNsInfo(kProjectorState state, kInfo64u *info)
Reports constraint and validity information for the ExposureNs setting.
Essential declarations related to FireSync nodes.
kStatus kProjectorState_SetIntensity(kProjectorState state, k32u intensity, kAdjust adjustment=kADJUST_NONE)
Sets the intensity for the projector state.
kStatus kProjectorState_IntensityInfo(kProjectorState state, kInfo32u *info)
Reports constraint and validity information for the Intensity setting.
kSize kProjectorState_Id(kProjectorState state)
Gets the id of the state.
kStatus kProjectorState_GapNsInfo(kProjectorState state, kInfo64u *info)
Reports constraint and validity information for the GapNs setting.
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:234
k64u kProjectorState_NominateCameraExposureNs(kProjectorState state, k64u exposure)
Based on a desired exposure, suggests a camera exposure (ns) that can be used to avoid projector arti...
k64u kProjectorState_DurationNs(kProjectorState state)
Reports the total time required to execute this projector state, in nanoseconds.
k32u kProjectorState_Intensity(kProjectorState state)
Gets the intensity for the projector state.
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:98
kStatus kProjectorState_AutoGapEnabledInfo(kProjectorState state, kInfoBool *info)
Reports constraint and validity information for the AutoGapEnabled setting.
k64u kProjectorState_ExposureNs(kProjectorState state)
Gets the exposure for the projector state, in nanoseconds.
kStatus kProjectorState_SetGapNs(kProjectorState state, k64u gap, kAdjust adjustment=kADJUST_NONE)
Sets the gap for the projector state, in nanoseconds.
Represents a projector state configuration.
k64u kProjectorState_ImageTimeNs(kProjectorState state)
Reports the projector image time based on the state configuration, in nanoseconds.
k64u kProjectorState_GapNs(kProjectorState state)
Gets the gap for the projector state, in nanoseconds.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493
kStatus kProjectorState_SetExposureNs(kProjectorState state, k64u exposure, kAdjust adjustment=kADJUST_NONE)
Sets the exposure for the projector state, in nanoseconds.