FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kFsUtils.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_UTILS_H
9 #define K_FIRESYNC_UTILS_H
10 
11 #include <kFireSync/kFsDef.h>
12 #include <kFireSync/Utils/kInfo.h>
13 #include <kFireSync/kNodeDef.h>
14 
23 typedef kStatus (kCall* kLoadStreamFx)(kObject* object, kStream stream, kAlloc allocator);
24 
32 typedef kStatus (kCall* kSaveStreamFx)(kObject object, kStream stream);
33 
50 kFsFx(kStatus) kLoadFromFile(kObject* object, const kChar* path, kLoadStreamFx loadFunction, kAlloc allocator);
51 
61 kFsFx(kStatus) kSaveToFile(kObject object, const kChar* path, kSaveStreamFx saveFunction);
62 
70 kFsFx(k32u) kCountBits32u(k32u value);
71 
84 kFsFx(kStatus) kFsUtils_FindPsProgram(const kChar* programName, kControllerType type, kBool isDebug, kChar* path, kSize capacity);
85 
97 kFsFx(kStatus) kFindPlProgram(k32u configuration, kVersion expectingVersion, kChar* path, kSize capacity, kVersion* version);
98 
109 kFsFx(kStatus) kFindOsProgram(kControllerType type, kChar* path, kSize capacity, kVersion* version);
110 
124 kFsFx(kStatus) kCalculateSubframe(kSize desiredSubframeCount, kSize pixelCount, kSize* subframeCount, kSize* subframeCapacity);
125 
126 #include <kFireSync/Utils/kFsUtils.x.h>
127 
128 #endif
kFsUtils::kCountBits32u
k32u kCountBits32u(k32u value)
Counts the number of bits that are set in a 32-bit unsigned integer.
kInfo.h
Declares the kInfo family of structures.
kLoadStreamFx
kStatus(kCall * kLoadStreamFx)(kObject *object, kStream stream, kAlloc allocator)
Callback signature used with the kLoadFromFile function.
Definition: kFsUtils.h:23
kFsUtils::kCalculateSubframe
kStatus kCalculateSubframe(kSize desiredSubframeCount, kSize pixelCount, kSize *subframeCount, kSize *subframeCapacity)
Calculates the expected compressed subframe capacity given a desired number of subframes and image si...
kFsUtils::kFindPlProgram
kStatus kFindPlProgram(k32u configuration, kVersion expectingVersion, kChar *path, kSize capacity, kVersion *version)
Gives the path and the version of a Pl file given a specific configuration.
kNodeDef.h
Essential declarations related to FireSync nodes.
kFsUtils::kFindOsProgram
kStatus kFindOsProgram(kControllerType type, kChar *path, kSize capacity, kVersion *version)
Obtain the absolute path to the OS firmware program and its version.
kFsDef.h
Essential API declarations for the kFireSync library.
kControllerType
Represents types of node controllers.
kFsUtils::kFsUtils_FindPsProgram
kStatus kFsUtils_FindPsProgram(const kChar *programName, kControllerType type, kBool isDebug, kChar *path, kSize capacity)
This function returns the fully qualified (absolute) path for a given program name based on the contr...
kFsUtils::kLoadFromFile
kStatus kLoadFromFile(kObject *object, const kChar *path, kLoadStreamFx loadFunction, kAlloc allocator)
Loads a file and parses a user-defined object from the file using the specified callback.
kFsUtils::kSaveToFile
kStatus kSaveToFile(kObject object, const kChar *path, kSaveStreamFx saveFunction)
Formats a user-defined object using the specified callback and saves the result to file...
kSaveStreamFx
kStatus(kCall * kSaveStreamFx)(kObject object, kStream stream)
Callback signature used with the kSaveToFile function.
Definition: kFsUtils.h:32