FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kUnpackedCompressedPhase.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_UNPACKED_COMPRESSED_PHASE_H
9 #define K_FIRESYNC_UNPACKED_COMPRESSED_PHASE_H
10 
11 #include <kFireSync/kFsDef.h>
12 #include <kFireSync/Data/kUnpackedCompressedPhase.x.h>
13 
23 //typedef kObject kUnpackedCompressedPhase; --forward-declared in kFsDef.x.h
24 
34 
45 
55 {
57 
58  obj->isIntensity = isIntensity;
59 
60  return kOK;
61 }
62 
71 {
73 
74  return obj->isIntensity;
75 }
76 
86 {
88 
89  obj->prediction = prediction;
90 
91  return kOK;
92 }
93 
102 {
104 
105  return obj->prediction;
106 }
107 
117 {
119 
120  obj->subframeLength = subframeLength;
121 
122  return kOK;
123 }
124 
133 {
135 
136  return obj->subframeLength;
137 }
138 
149 {
151 
152  obj->length[dimension] = length;
153 
154  return kOK;
155 }
156 
166 {
168 
169  return obj->length[dimension];
170 }
171 
181 {
183 
184  obj->deltaBitDepth = bitDepth;
185 
186  return kOK;
187 }
188 
197 {
199 
200  return obj->deltaBitDepth;
201 }
202 
212 {
214 
215  obj->fail1BitDepth = bitDepth;
216 
217  return kOK;
218 }
219 
228 {
230 
231  return obj->fail1BitDepth;
232 }
233 
243 {
245 
246  obj->fail2BitDepth = bitDepth;
247 
248  return kOK;
249 }
250 
259 {
261 
262  return obj->fail2BitDepth;
263 }
264 
274 {
276 
277  obj->nullBitDepth = bitDepth;
278 
279  return kOK;
280 }
281 
290 {
292 
293  return obj->nullBitDepth;
294 }
295 
304 {
306 
307  return obj->deltaList;
308 }
309 
318 {
320 
321  return obj->fail1List;
322 }
323 
332 {
334 
335  return obj->fail2List;
336 }
337 
346 {
348 
349  return obj->nullList;
350 }
351 
352 #endif
Represents unpacked lists of compressed phase or intensity stream entries.
kStatus kUnpackedCompressedPhase_SetLength(kUnpackedCompressedPhase data, kSize dimension, kSize length)
Sets the specified uncompressed array dimension length associated with this frame.
Definition: kUnpackedCompressedPhase.h:148
k32u kUnpackedCompressedPhase_Fail1BitDepth(kUnpackedCompressedPhase data)
Reports the fail-first bit depth associated with this frame.
Definition: kUnpackedCompressedPhase.h:227
kStatus kUnpackedCompressedPhase_SetDeltaBitDepth(kUnpackedCompressedPhase data, k32u bitDepth)
Sets the delta bit depth associated with this frame.
Definition: kUnpackedCompressedPhase.h:180
kStatus kUnpackedCompressedPhase_SetFail2BitDepth(kUnpackedCompressedPhase data, k32u bitDepth)
Sets the fail-second bit depth associated with this frame.
Definition: kUnpackedCompressedPhase.h:242
kStatus kUnpackedCompressedPhase_Construct(kUnpackedCompressedPhase *data, kAlloc allocator)
Constructs a kUnpackedCompressedPhase object.
kBool kUnpackedCompressedPhase_IsIntensity(kUnpackedCompressedPhase data)
Reports whether this object represents intensity (vs phase) data.
Definition: kUnpackedCompressedPhase.h:70
k32s kUnpackedCompressedPhase_Prediction(kUnpackedCompressedPhase data)
Prediction value associated with this frame.
Definition: kUnpackedCompressedPhase.h:101
k32u kUnpackedCompressedPhase_DeltaBitDepth(kUnpackedCompressedPhase data)
Reports the delta bit depth associated with this frame.
Definition: kUnpackedCompressedPhase.h:196
kStatus kUnpackedCompressedPhase_SetPrediction(kUnpackedCompressedPhase data, k32u prediction)
Sets prediction value associated with this frame.
Definition: kUnpackedCompressedPhase.h:85
#define kInlineFx(TYPE)
kArrayList kUnpackedCompressedPhase_Fail2List(kUnpackedCompressedPhase data)
Provides reference to fail-second list.
Definition: kUnpackedCompressedPhase.h:331
k32u kUnpackedCompressedPhase_Fail2BitDepth(kUnpackedCompressedPhase data)
Reports the fail-second bit depth associated with this frame.
Definition: kUnpackedCompressedPhase.h:258
kSize kUnpackedCompressedPhase_SubframeLength(kUnpackedCompressedPhase data)
Uncompressed subframe length for this subframe.
Definition: kUnpackedCompressedPhase.h:132
#define kObj(TypeName_T, T_object)
Essential API declarations for the kFireSync library.
k32u kUnpackedCompressedPhase_NullBitDepth(kUnpackedCompressedPhase data)
Reports the null bit depth associated with this frame.
Definition: kUnpackedCompressedPhase.h:289
kArrayList kUnpackedCompressedPhase_Fail1List(kUnpackedCompressedPhase data)
Provides reference to fail-first list.
Definition: kUnpackedCompressedPhase.h:317
kSize kUnpackedCompressedPhase_Length(kUnpackedCompressedPhase data, kSize dimension)
Reports the specified uncompressed array dimension length associated with this frame.
Definition: kUnpackedCompressedPhase.h:165
kStatus kUnpackedCompressedPhase_SetFail1BitDepth(kUnpackedCompressedPhase data, k32u bitDepth)
Sets the fail-first bit depth associated with this frame.
Definition: kUnpackedCompressedPhase.h:211
kStatus kUnpackedCompressedPhase_SetSubframeLength(kUnpackedCompressedPhase data, kSize subframeLength)
Sets uncompressed subframe length for this subframe.
Definition: kUnpackedCompressedPhase.h:116
#define kOK
kArrayList kUnpackedCompressedPhase_NullList(kUnpackedCompressedPhase data)
Provides reference to null list.
Definition: kUnpackedCompressedPhase.h:345
kStatus kUnpackedCompressedPhase_SetIsIntensity(kUnpackedCompressedPhase data, kBool isIntensity)
Sets whether this object represents intensity (vs phase) data.
Definition: kUnpackedCompressedPhase.h:54
kArrayList kUnpackedCompressedPhase_DeltaList(kUnpackedCompressedPhase data)
Provides reference to delta list.
Definition: kUnpackedCompressedPhase.h:303
Represents compressed phase (and/or intensity) data.
kStatus kUnpackedCompressedPhase_SetNullBitDepth(kUnpackedCompressedPhase data, k32u bitDepth)
Sets the null bit depth associated with this frame.
Definition: kUnpackedCompressedPhase.h:273
kStatus kUnpackedCompressedPhase_ConfigureFrom(kUnpackedCompressedPhase data, kBool isIntensity, kCompressedPhase compressed)
Initializes this object based on metadata from a compressed phase object.