FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kCamera.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_CAMERA_H
9 #define K_FIRESYNC_CAMERA_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kCamera; --forward-declared in kFsDef.x.h
22 
23 
34 kFsFx(kCameraModel) kCamera_Model(kCamera camera);
35 
46 kFsFx(kSize) kCamera_Id(kCamera camera);
47 
56 
65 kFsFx(kStatus) kCamera_Clear(kCamera camera, kSize stateCount);
66 
75 kFsFx(kStatus) kCamera_ClearAll(kCamera camera, kSize stateCount);
76 
85 
98 
107 
119 kFsFx(kStatus) kCamera_Enable(kCamera camera, kBool enable);
120 
128 kFsFx(kBool) kCamera_IsEnabled(kCamera camera);
129 
144 kFsFx(kBool) kCamera_IsConnected(kCamera camera);
145 
157 kFsFx(kStatus) kCamera_SetControl(kCamera camera, kCameraControl type);
158 
166 kFsFx(kCameraControl) kCamera_Control(kCamera camera);
167 
176 kFsFx(kStatus) kCamera_ControlInfo(kCamera camera, kInfoBits* info);
177 
189 kFsFx(kStatus) kCamera_SetControlId(kCamera camera, k32u id);
190 
198 kFsFx(k32u) kCamera_ControlId(kCamera camera);
199 
208 kFsFx(kStatus) kCamera_ControlIdInfo(kCamera camera, kInfo* info);
209 
220 kFsFx(kStatus) kCamera_AddState(kCamera camera, kCameraState* state);
221 
230 kFsFx(kStatus) kCamera_DeleteState(kCamera camera, kCameraState state);
231 
241 kFsFx(kStatus) kCamera_SwapStates(kCamera camera, kSize index0, kSize index1);
242 
250 kFsFx(kSize) kCamera_StateCount(kCamera camera);
251 
260 kFsFx(kStatus) kCamera_StateCountInfo(kCamera camera, kInfoSize* info);
261 
270 kFsFx(kCameraState) kCamera_StateAt(kCamera camera, kSize index);
271 
283 kFsFx(kStatus) kCamera_AddExtension(kCamera camera, kType type, kCameraExt* extension);
284 
293 kFsFx(kStatus) kCamera_DeleteExtension(kCamera camera, kCameraExt extension);
294 
302 kFsFx(kSize) kCamera_ExtensionCount(kCamera camera);
303 
312 kFsFx(kCameraExt) kCamera_ExtensionAt(kCamera camera, kSize index);
313 
323 kFsFx(k64u) kCamera_MinimumPeriod(kCamera camera);
324 
337 kFsFx(kStatus) kCamera_SetReadout(kCamera camera, kCameraReadout readoutMode);
338 
350 kFsFx(kCameraReadout) kCamera_Readout(kCamera camera);
351 
364 kFsFx(kStatus) kCamera_ReadoutInfo(kCamera camera, kInfoBits* info);
365 
379 kFsFx(kStatus) kCamera_EnableRamImage(kCamera camera, kBool enabled);
380 
388 kFsFx(kBool) kCamera_RamImageEnabled(kCamera camera);
389 
398 kFsFx(kBool) kCamera_RamImageEnabledInfo(kCamera camera, kInfoBool* info);
399 
408 kFsFx(kStatus) kCamera_EnablePrnu(kCamera camera, kBool enabled);
409 
417 kFsFx(kBool) kCamera_PrnuEnabled(kCamera camera);
418 
427 kFsFx(kBool) kCamera_PrnuEnabledInfo(kCamera camera, kInfoBool* info);
428 
437 kFsFx(kStatus) kCamera_EnableFpn(kCamera camera, kBool enabled);
438 
446 kFsFx(kBool) kCamera_FpnEnabled(kCamera camera);
447 
456 kFsFx(kBool) kCamera_FpnEnabledInfo(kCamera camera, kInfoBool* info);
457 
467 kFsFx(kStatus) kCamera_WritePrnu(kCamera camera, kImage white, kImage black);
468 
477 kFsFx(kStatus) kCamera_WriteFpn(kCamera camera, kImage offsets);
478 
490 kFsFx(kStatus) kCamera_WriteRangeLut(kCamera camera, const kRangeLutParams* params, const kRangeLutArray* xArray,
491  const kRangeLutArray* zArray, const kRangeLutArray* validArray);
492 
501 kFsFx(kStatus) kCamera_Stats(kCamera camera, kCameraStats* stats);
502 
512 
521 
531 
544 
553 
563 
571 kFsFx(kStatus) kCamera_Trigger(kCamera camera);
572 
587 kFsFx(kStatus) kCamera_Override(kCamera camera, const kCameraOverrideItem* overrides, kSize count);
588 
589 kEndHeader()
590 
591 #include <kFireSync/Client/kCamera.x.h>
592 
593 #endif
kStatus kCamera_EnableRamImage(kCamera camera, kBool enabled)
Specifies whether the FPGA RAM Image feature is enabled.
kStatus kCamera_SetReadout(kCamera camera, kCameraReadout readoutMode)
Sets the readout mode for the camera.
kStatus kCamera_ReadoutInfo(kCamera camera, kInfoBits *info)
Reports constraint and validity information for the Readout setting.
kBool kCamera_FpnEnabled(kCamera camera)
Reports whether FPN is currently enabled.
Represents a camera state configuration.
k32u kCamera_InputCounterSourceId(kCamera camera)
Gets the input counter source id for a camera.
kStatus kCamera_SetControlId(kCamera camera, k32u id)
Sets the control source id for a camera.
kStatus kCamera_Stats(kCamera camera, kCameraStats *stats)
Retrieve statistics.
kSize kCamera_ExtensionCount(kCamera camera)
Gets the number of control extensions that have been configured.
kSize kCamera_StateCount(kCamera camera)
Gets the number of states belonging to the camera.
Represents camera run-time statistics.
Definition: kNodeDef.h:585
kBool kCamera_PrnuEnabledInfo(kCamera camera, kInfoBool *info)
Reports constraint and validity information for the PrnuEnabled setting.
kCameraExt kCamera_ExtensionAt(kCamera camera, kSize index)
Gets the control extension at the specified index.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
kStatus kCamera_StateCountInfo(kCamera camera, kInfoSize *info)
Reports constraint and validity information for the StateCount setting.
Represents camera control modes.
k32u kCamera_ControlId(kCamera camera)
Gets the control source id for a camera.
Represents camera configuration.
kBool kCamera_PrnuEnabled(kCamera camera)
Reports whether PRNU is currently enabled.
kStatus kCamera_SetInputCounterSource(kCamera camera, kCameraInputCounterSource source)
Sets the input counter source for a camera.
kStatus kCamera_DeleteExtension(kCamera camera, kCameraExt extension)
Destroys the specified camera control extension and removes it from the camera's extension list...
Essential declarations related to FireSync nodes.
kStatus kCamera_Enable(kCamera camera, kBool enable)
Enables or disables the camera.
Represents the input counter source.
kStatus kCamera_AddExtension(kCamera camera, kType type, kCameraExt *extension)
Creates and adds a new camera control extension of the specified type.
kBool kCamera_IsConnected(kCamera camera)
Reports whether a camera device is connected and communicating.
kStatus kCamera_EnablePrnu(kCamera camera, kBool enabled)
Specifies whether PRNU is enabled.
Represents camera override item.
Definition: kNodeDef.h:331
kStatus kCamera_WriteRangeLut(kCamera camera, const kRangeLutParams *params, const kRangeLutArray *xArray, const kRangeLutArray *zArray, const kRangeLutArray *validArray)
Writes FPGA Range LUT.
kStatus kCamera_ControlIdInfo(kCamera camera, kInfo *info)
Reports constraint and validity information for the ControlId setting.
kStatus kCamera_DeleteState(kCamera camera, kCameraState state)
Destroys the specified state and removes it from the camera's state list.
kSize kCamera_FrameBufferSize(kCamera camera)
Reports the current camera frame buffer size.
Abstract base class for camera control extension parameters.
kCameraReadout kCamera_Readout(kCamera camera)
Gets the readout mode for the camera.
kStatus kCamera_ClearAll(kCamera camera, kSize stateCount)
Resets camera mode and device settings to defaults.
kCameraInputCounterSource kCamera_InputCounterSource(kCamera camera)
Retrieves the input counter source.
kStatus kCamera_EnableFpn(kCamera camera, kBool enabled)
Specifies whether FPN is enabled.
kStatus kCamera_Trigger(kCamera camera)
Provides a software trigger to a camera.
kStatus kCamera_SetControl(kCamera camera, kCameraControl type)
Sets the control mode of the camera.
kBool kCamera_FpnEnabledInfo(kCamera camera, kInfoBool *info)
Reports constraint and validity information for the FpnEnabled setting.
kBool kCamera_RamImageEnabled(kCamera camera)
Reports whether the FPGA RAM Image feature is currently enabled.
kCameraState kCamera_StateAt(kCamera camera, kSize index)
Gets the state at the specified index.
kStatus kCamera_SetInputCounterSourceId(kCamera camera, k32u id)
Sets the input counter source id for a camera.
kStatus kCamera_AddState(kCamera camera, kCameraState *state)
Creates and adds a new state with default values.
kStatus kCamera_ControlInfo(kCamera camera, kInfoBits *info)
Reports constraint and validity information for the Control setting.
Represents camera readout mode.
kStatus kCamera_InputCounterSourceIdInfo(kCamera camera, kInfo *info)
Reports constraint and validity information for the InputCounterSourceId setting. ...
kSize kCamera_NextFrameBufferSize(kCamera camera)
Reports the frame buffer size that will take effect after reset.
kCameraAlgorithm kCamera_Algorithm(kCamera camera)
Gets the hardware-accelerated algorithm supported by this camera.
kSize kCamera_Id(kCamera camera)
Gets the id of the camera module.
Represents camera hardware-accelerated algorithm types.
kStatus kCamera_WritePrnu(kCamera camera, kImage white, kImage black)
Writes PRNU table.
kStatus kCamera_InputCounterSourceInfo(kCamera camera, kInfoBits *info)
Reports constraint and validity information for the Input Counter Source setting. ...
kStatus kCamera_SwapStates(kCamera camera, kSize index0, kSize index1)
Swaps the order of two states in the camera's state list.
kStatus kCamera_WriteFpn(kCamera camera, kImage offsets)
Writes FPN table.
kStatus kCamera_Clear(kCamera camera, kSize stateCount)
Resets camera mode settings to defaults.
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:295
kCameraControl kCamera_Control(kCamera camera)
Reports the control mode of the camera.
Represents supported camera device types.
kBool kCamera_IsEnabled(kCamera camera)
Reports whether the camera is currently enabled.
kStatus kCamera_SetNextFrameBufferSize(kCamera camera, kSize size)
Sets the frame buffer size that will take effect after reset.
kStatus kCamera_Override(kCamera camera, const kCameraOverrideItem *overrides, kSize count)
Provides a list of configuration overrides to modify live camera behaviour.
kCameraModel kCamera_Model(kCamera camera)
Gets the model of the camera.
k64u kCamera_MinimumPeriod(kCamera camera)
Reports the time required by this camera to respond to an event.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:45
kBool kCamera_RamImageEnabledInfo(kCamera camera, kInfoBool *info)
Reports constraint and validity information for the RamImageEnabled setting.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:403