FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kLightState.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_LIGHT_STATE_H
9 #define K_FIRESYNC_LIGHT_STATE_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kLightState; --forward-declared in kFsDef.x.h
20 
30 kFsFx(kSize) kLightState_Id(kLightState state);
31 
43 kFsFx(kStatus) kLightState_SetDelayNs(kLightState state, k64u delay, kAdjust adjustment = kADJUST_NONE);
44 
54 kFsFx(k64u) kLightState_DelayNs(kLightState state);
55 
64 kFsFx(kStatus) kLightState_DelayNsInfo(kLightState state, kInfo64u* info);
65 
77 kFsFx(kStatus) kLightState_SetExposureNs(kLightState state, k64u exposure, kAdjust adjustment = kADJUST_NONE);
78 
88 kFsFx(k64u) kLightState_ExposureNs(kLightState state);
89 
98 kFsFx(kStatus) kLightState_ExposureNsInfo(kLightState state, kInfo64u* info);
99 
111 kFsFx(kStatus) kLightState_SetGapNs(kLightState state, k64u gap, kAdjust adjustment = kADJUST_NONE);
112 
122 kFsFx(k64u) kLightState_GapNs(kLightState state);
123 
132 kFsFx(kStatus) kLightState_GapNsInfo(kLightState state, kInfo64u* info);
133 
143 kFsFx(k64u) kLightState_DurationNs(kLightState state);
144 
155 kFsFx(k64u) kLightState_LeadInNs(kLightState state);
156 
167 kFsFx(k64u) kLightState_TotalLeadInNs(kLightState state);
168 
179 kFsFx(k64u) kLightState_LeadOutNs(kLightState state);
180 
191 kFsFx(k64u) kLightState_TotalLeadOutNs(kLightState state);
192 
203 kFsFx(k64u) kLightState_PreExposureNs(kLightState state);
204 
215 kFsFx(k64u) kLightState_PostExposureNs(kLightState state);
216 
217 #include <kFireSync/Client/kLightState.x.h>
218 
219 #endif
kLightState::kLightState_Id
kSize kLightState_Id(kLightState state)
Gets the id of the state.
kLightState::kLightState_GapNs
k64u kLightState_GapNs(kLightState state)
Gets the gap for the light state, in nanoseconds.
kLightState::kLightState_ExposureNsInfo
kStatus kLightState_ExposureNsInfo(kLightState state, kInfo64u *info)
Reports constraint and validity information for the ExposureNs setting.
kLightState::kLightState_SetExposureNs
kStatus kLightState_SetExposureNs(kLightState state, k64u exposure, kAdjust adjustment=kADJUST_NONE)
Sets the exposure for the light state, in nanoseconds.
kLightState
Represents a light state configuration.
kLightState::kLightState_DurationNs
k64u kLightState_DurationNs(kLightState state)
Reports the total time required to execute this light state, in nanoseconds.
kAdjust
Type of adjustment to perform to bring a setting into conformance with its constraints.
kAdjust::kADJUST_NONE
#define kADJUST_NONE
No adjustment.
Definition: kInfo.h:48
kLightState::kLightState_LeadInNs
k64u kLightState_LeadInNs(kLightState state)
Reports the lead-in time for the light state.
kLightState::kLightState_LeadOutNs
k64u kLightState_LeadOutNs(kLightState state)
Reports the lead-out time for the light state.
kNodeDef.h
Essential declarations related to FireSync nodes.
kLightState::kLightState_GapNsInfo
kStatus kLightState_GapNsInfo(kLightState state, kInfo64u *info)
Reports constraint and validity information for the GapNs setting.
kCameraState::kLightState_TotalLeadOutNs
k64u kLightState_TotalLeadOutNs(kLightState state)
Reports the total lead-out time for the light state.
kLightState::kLightState_SetGapNs
kStatus kLightState_SetGapNs(kLightState state, k64u gap, kAdjust adjustment=kADJUST_NONE)
Sets the gap for the light state, in nanoseconds.
kLightState::kLightState_SetDelayNs
kStatus kLightState_SetDelayNs(kLightState state, k64u delay, kAdjust adjustment=kADJUST_NONE)
Sets the delay for the light state, in nanoseconds.
kLightState::kLightState_PostExposureNs
k64u kLightState_PostExposureNs(kLightState state)
Estimates the time for which the light may be emissive after nominal exposure.
kInfo64u
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:234
kLightState::kLightState_ExposureNs
k64u kLightState_ExposureNs(kLightState state)
Gets the exposure for the light state, in nanoseconds.
kLightState::kLightState_PreExposureNs
k64u kLightState_PreExposureNs(kLightState state)
Estimates the time for which the light may be emissive prior to nominal exposure. ...
kLightState::kLightState_DelayNsInfo
kStatus kLightState_DelayNsInfo(kLightState state, kInfo64u *info)
Reports constraint and validity information for the DelayNs setting, in nanoseconds.
kLightState::kLightState_DelayNs
k64u kLightState_DelayNs(kLightState state)
Gets the delay for the light state, in nanoseconds.
kCameraState::kLightState_TotalLeadInNs
k64u kLightState_TotalLeadInNs(kLightState state)
Reports the total lead-in time for the light state.