|
MeshLib C Docs
|
|
MeshLib C Docs
|
Go to the source code of this file.
Typedefs | |
| typedef struct MR_ZlibParams | MR_ZlibParams |
| typedef struct MR_ZlibCompressStats | MR_ZlibCompressStats |
| typedef struct MR_ZlibCompressParams | MR_ZlibCompressParams |
| typedef struct MR_ZlibCompressParams MR_ZlibCompressParams |
parameters for zlibCompressStream (adds a compression level on top of ZlibParams) Generated from class MR::ZlibCompressParams. Base classes: Direct: (non-virtual) MR::ZlibParams Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).
| typedef struct MR_ZlibCompressStats MR_ZlibCompressStats |
statistics gathered during compression: CRC-32 of the uncompressed input and the total numbers of bytes read from / written to the streams Generated from class MR::ZlibCompressStats. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).
| typedef struct MR_ZlibParams MR_ZlibParams |
parameters shared by zlibCompressStream and zlibDecompressStream Generated from class MR::ZlibParams. Derived classes: Direct: (non-virtual) MR::ZlibCompressParams Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).
| MRC_API MR_ZlibCompressParams * MR_ZlibCompressParams_AssignFromAnother | ( | MR_ZlibCompressParams * | _this, |
| const MR_ZlibCompressParams * | _other ) |
Generated from method MR::ZlibCompressParams::operator=. Parameter _this can not be null. It is a single object. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The returned pointer will never be null. It is non-owning, do NOT destroy it. When this function is called, this object will drop any object references it held previously.
| MRC_API MR_ZlibCompressParams * MR_ZlibCompressParams_ConstructFromAnother | ( | const MR_ZlibCompressParams * | _other | ) |
Generated from constructor MR::ZlibCompressParams::ZlibCompressParams. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ZlibCompressParams_Destroy() to free it when you're done using it.
| MRC_API MR_ZlibCompressParams * MR_ZlibCompressParams_DefaultConstruct | ( | void | ) |
Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_ZlibCompressParams_Destroy() to free it when you're done using it.
| MRC_API MR_ZlibCompressParams * MR_ZlibCompressParams_DefaultConstructArray | ( | size_t | num_elems | ) |
Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_ZlibCompressParams_DestroyArray(). Use MR_ZlibCompressParams_OffsetMutablePtr() and MR_ZlibCompressParams_OffsetPtr() to access the array elements.
| MRC_API void MR_ZlibCompressParams_Destroy | ( | const MR_ZlibCompressParams * | _this | ) |
Destroys a heap-allocated instance of MR_ZlibCompressParams. Does nothing if the pointer is null.
| MRC_API void MR_ZlibCompressParams_DestroyArray | ( | const MR_ZlibCompressParams * | _this | ) |
Destroys a heap-allocated array of MR_ZlibCompressParams. Does nothing if the pointer is null.
| MRC_API const int * MR_ZlibCompressParams_Get_level | ( | const MR_ZlibCompressParams * | _this | ) |
compression level: 0 = no compression, 1 = the fastest but the most inefficient, 9 = the most efficient but the slowest; -1 = zlib's default Returns a pointer to a member variable of class MR::ZlibCompressParams named level. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API const bool * MR_ZlibCompressParams_Get_rawDeflate | ( | const MR_ZlibCompressParams * | _this | ) |
wire format of the (de)compressed bytes: true → raw deflate (RFC 1951, no wrapper) — suitable for a ZIP entry; false (default) → zlib-wrapped (RFC 1950) Returns a pointer to a member variable of class MR::ZlibCompressParams named rawDeflate. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API MR_ZlibCompressStats *const * MR_ZlibCompressParams_Get_stats | ( | const MR_ZlibCompressParams * | _this | ) |
optional output; if non-null, the pointed-to object is populated with CRC-32 of the input and the uncompressed / compressed byte totals Returns a pointer to a member variable of class MR::ZlibCompressParams named stats. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API int * MR_ZlibCompressParams_GetMutable_level | ( | MR_ZlibCompressParams * | _this | ) |
compression level: 0 = no compression, 1 = the fastest but the most inefficient, 9 = the most efficient but the slowest; -1 = zlib's default Returns a mutable pointer to a member variable of class MR::ZlibCompressParams named level. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API bool * MR_ZlibCompressParams_GetMutable_rawDeflate | ( | MR_ZlibCompressParams * | _this | ) |
wire format of the (de)compressed bytes: true → raw deflate (RFC 1951, no wrapper) — suitable for a ZIP entry; false (default) → zlib-wrapped (RFC 1950) Returns a mutable pointer to a member variable of class MR::ZlibCompressParams named rawDeflate. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API MR_ZlibCompressStats ** MR_ZlibCompressParams_GetMutable_stats | ( | MR_ZlibCompressParams * | _this | ) |
optional output; if non-null, the pointed-to object is populated with CRC-32 of the input and the uncompressed / compressed byte totals Returns a mutable pointer to a member variable of class MR::ZlibCompressParams named stats. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API MR_ZlibCompressParams * MR_ZlibCompressParams_MutableStaticDowncastFrom_MR_ZlibParams | ( | MR_ZlibParams * | object | ) |
Downcasts an instance of MR::ZlibParams to a derived class MR::ZlibCompressParams. This is a static downcast, it trusts the programmer that the target type is correct. Results in UB and returns an invalid pointer otherwise. The reference to the parameter object might be preserved in the return value.
| MRC_API MR_ZlibParams * MR_ZlibCompressParams_MutableUpcastTo_MR_ZlibParams | ( | MR_ZlibCompressParams * | object | ) |
Upcasts an instance of MR::ZlibCompressParams to its base class MR::ZlibParams. The reference to the parameter object might be preserved in the return value.
| MRC_API MR_ZlibCompressParams * MR_ZlibCompressParams_OffsetMutablePtr | ( | MR_ZlibCompressParams * | ptr, |
| ptrdiff_t | i ) |
Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.
| MRC_API const MR_ZlibCompressParams * MR_ZlibCompressParams_OffsetPtr | ( | const MR_ZlibCompressParams * | ptr, |
| ptrdiff_t | i ) |
Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.
| MRC_API void MR_ZlibCompressParams_Set_level | ( | MR_ZlibCompressParams * | _this, |
| int | value ) |
compression level: 0 = no compression, 1 = the fastest but the most inefficient, 9 = the most efficient but the slowest; -1 = zlib's default Modifies a member variable of class MR::ZlibCompressParams named level. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it held previously in level.
| MRC_API void MR_ZlibCompressParams_Set_rawDeflate | ( | MR_ZlibCompressParams * | _this, |
| bool | value ) |
wire format of the (de)compressed bytes: true → raw deflate (RFC 1951, no wrapper) — suitable for a ZIP entry; false (default) → zlib-wrapped (RFC 1950) Modifies a member variable of class MR::ZlibCompressParams named rawDeflate. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it held previously in rawDeflate.
| MRC_API void MR_ZlibCompressParams_Set_stats | ( | MR_ZlibCompressParams * | _this, |
| MR_ZlibCompressStats * | value ) |
optional output; if non-null, the pointed-to object is populated with CRC-32 of the input and the uncompressed / compressed byte totals Modifies a member variable of class MR::ZlibCompressParams named stats. Parameter _this can not be null. It is a single object. The reference to the parameter value might be preserved in this object in element stats. When this function is called, this object will drop object references it held previously in stats.
| MRC_API const MR_ZlibCompressParams * MR_ZlibCompressParams_StaticDowncastFrom_MR_ZlibParams | ( | const MR_ZlibParams * | object | ) |
Downcasts an instance of MR::ZlibParams to a derived class MR::ZlibCompressParams. This is a static downcast, it trusts the programmer that the target type is correct. Results in UB and returns an invalid pointer otherwise. This version is acting on mutable pointers. The reference to the parameter object might be preserved in the return value.
| MRC_API const MR_ZlibParams * MR_ZlibCompressParams_UpcastTo_MR_ZlibParams | ( | const MR_ZlibCompressParams * | object | ) |
Upcasts an instance of MR::ZlibCompressParams to its base class MR::ZlibParams. This version is acting on mutable pointers. The reference to the parameter object might be preserved in the return value.
| MRC_API MR_ZlibCompressStats * MR_ZlibCompressStats_AssignFromAnother | ( | MR_ZlibCompressStats * | _this, |
| const MR_ZlibCompressStats * | _other ) |
Generated from method MR::ZlibCompressStats::operator=. Parameter _this can not be null. It is a single object. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The returned pointer will never be null. It is non-owning, do NOT destroy it. When this function is called, this object will drop any object references it held previously.
| MRC_API MR_ZlibCompressStats * MR_ZlibCompressStats_ConstructFrom | ( | unsigned int | crc32, |
| MR_uint64_t | uncompressedSize, | ||
| MR_uint64_t | compressedSize ) |
Constructs MR::ZlibCompressStats elementwise. The reference to the parameter crc32 might be preserved in the constructed object. The reference to the parameter uncompressedSize might be preserved in the constructed object. The reference to the parameter compressedSize might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ZlibCompressStats_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it held previously.
| MRC_API MR_ZlibCompressStats * MR_ZlibCompressStats_ConstructFromAnother | ( | const MR_ZlibCompressStats * | _other | ) |
Generated from constructor MR::ZlibCompressStats::ZlibCompressStats. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ZlibCompressStats_Destroy() to free it when you're done using it.
| MRC_API MR_ZlibCompressStats * MR_ZlibCompressStats_DefaultConstruct | ( | void | ) |
Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_ZlibCompressStats_Destroy() to free it when you're done using it.
| MRC_API MR_ZlibCompressStats * MR_ZlibCompressStats_DefaultConstructArray | ( | size_t | num_elems | ) |
Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_ZlibCompressStats_DestroyArray(). Use MR_ZlibCompressStats_OffsetMutablePtr() and MR_ZlibCompressStats_OffsetPtr() to access the array elements.
| MRC_API void MR_ZlibCompressStats_Destroy | ( | const MR_ZlibCompressStats * | _this | ) |
Destroys a heap-allocated instance of MR_ZlibCompressStats. Does nothing if the pointer is null.
| MRC_API void MR_ZlibCompressStats_DestroyArray | ( | const MR_ZlibCompressStats * | _this | ) |
Destroys a heap-allocated array of MR_ZlibCompressStats. Does nothing if the pointer is null.
| MRC_API const MR_uint64_t * MR_ZlibCompressStats_Get_compressedSize | ( | const MR_ZlibCompressStats * | _this | ) |
total bytes written to the output stream Modifies a member variable of class MR::ZlibCompressStats named compressedSize. Parameter _this can not be null. It is a single object. The reference to the parameter value might be preserved in this object in element compressedSize. When this function is called, this object will drop object references it held previously in compressedSize.
| MRC_API const unsigned int * MR_ZlibCompressStats_Get_crc32 | ( | const MR_ZlibCompressStats * | _this | ) |
CRC-32 of the uncompressed input Modifies a member variable of class MR::ZlibCompressStats named crc32. Parameter _this can not be null. It is a single object. The reference to the parameter value might be preserved in this object in element crc32. When this function is called, this object will drop object references it held previously in crc32.
| MRC_API const MR_uint64_t * MR_ZlibCompressStats_Get_uncompressedSize | ( | const MR_ZlibCompressStats * | _this | ) |
total bytes read from the input stream Modifies a member variable of class MR::ZlibCompressStats named uncompressedSize. Parameter _this can not be null. It is a single object. The reference to the parameter value might be preserved in this object in element uncompressedSize. When this function is called, this object will drop object references it held previously in uncompressedSize.
| MRC_API MR_uint64_t * MR_ZlibCompressStats_GetMutable_compressedSize | ( | MR_ZlibCompressStats * | _this | ) |
| MRC_API unsigned int * MR_ZlibCompressStats_GetMutable_crc32 | ( | MR_ZlibCompressStats * | _this | ) |
total bytes read from the input stream Returns a pointer to a member variable of class MR::ZlibCompressStats named uncompressedSize. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API MR_uint64_t * MR_ZlibCompressStats_GetMutable_uncompressedSize | ( | MR_ZlibCompressStats * | _this | ) |
total bytes written to the output stream Returns a pointer to a member variable of class MR::ZlibCompressStats named compressedSize. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API MR_ZlibCompressStats * MR_ZlibCompressStats_OffsetMutablePtr | ( | MR_ZlibCompressStats * | ptr, |
| ptrdiff_t | i ) |
Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.
| MRC_API const MR_ZlibCompressStats * MR_ZlibCompressStats_OffsetPtr | ( | const MR_ZlibCompressStats * | ptr, |
| ptrdiff_t | i ) |
Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.
| MRC_API void MR_ZlibCompressStats_Set_compressedSize | ( | MR_ZlibCompressStats * | _this, |
| MR_uint64_t | value ) |
total bytes written to the output stream Returns a mutable pointer to a member variable of class MR::ZlibCompressStats named compressedSize. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API void MR_ZlibCompressStats_Set_crc32 | ( | MR_ZlibCompressStats * | _this, |
| unsigned int | value ) |
CRC-32 of the uncompressed input Returns a mutable pointer to a member variable of class MR::ZlibCompressStats named crc32. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API void MR_ZlibCompressStats_Set_uncompressedSize | ( | MR_ZlibCompressStats * | _this, |
| MR_uint64_t | value ) |
total bytes read from the input stream Returns a mutable pointer to a member variable of class MR::ZlibCompressStats named uncompressedSize. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API MR_expected_void_std_string * MR_zlibCompressStream_int | ( | MR_std_istream * | in, |
| MR_std_ostream * | out, | ||
| const int * | level ) |
compress the input data using the Deflate algorithm (zlib-wrapped, RFC 1950)
| level | - compression level (see ZlibCompressParams::level) Generated from function MR::zlibCompressStream. Parameter in can not be null. It is a single object. Parameter out can not be null. It is a single object. Parameter level has a default argument: -1, pass a null pointer to use it. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_void_std_string_Destroy() to free it when you're done using it. |
| MRC_API MR_expected_void_std_string * MR_zlibCompressStream_MR_ZlibCompressParams | ( | MR_std_istream * | in, |
| MR_std_ostream * | out, | ||
| const MR_ZlibCompressParams * | params ) |
compress the input data using the Deflate algorithm
| in | - input data stream |
| out | - output data stream |
| params | - compression parameters (wire format, level) |
| MRC_API MR_expected_void_std_string * MR_zlibDecompressStream_2 | ( | MR_std_istream * | in, |
| MR_std_ostream * | out ) |
decompress the input data compressed with the Deflate algorithm (zlib-wrapped, RFC 1950)
| MRC_API MR_expected_void_std_string * MR_zlibDecompressStream_3 | ( | MR_std_istream * | in, |
| MR_std_ostream * | out, | ||
| const MR_ZlibParams * | params ) |
decompress the input data compressed with the Deflate algorithm
| in | - input data stream |
| out | - output data stream |
| params | - decompression parameters (wire format) |
| MRC_API MR_ZlibParams * MR_ZlibParams_AssignFromAnother | ( | MR_ZlibParams * | _this, |
| const MR_ZlibParams * | _other ) |
Generated from method MR::ZlibParams::operator=. Parameter _this can not be null. It is a single object. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The returned pointer will never be null. It is non-owning, do NOT destroy it. When this function is called, this object will drop any object references it held previously. CRC-32 of the uncompressed input Returns a pointer to a member variable of class MR::ZlibCompressStats named crc32. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API MR_ZlibParams * MR_ZlibParams_ConstructFrom | ( | bool | rawDeflate | ) |
Constructs MR::ZlibParams elementwise. Never returns null. Returns an instance allocated on the heap! Must call MR_ZlibParams_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it held previously.
| MRC_API MR_ZlibParams * MR_ZlibParams_ConstructFromAnother | ( | const MR_ZlibParams * | _other | ) |
Generated from constructor MR::ZlibParams::ZlibParams. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_ZlibParams_Destroy() to free it when you're done using it.
| MRC_API MR_ZlibParams * MR_ZlibParams_DefaultConstruct | ( | void | ) |
Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_ZlibParams_Destroy() to free it when you're done using it.
| MRC_API MR_ZlibParams * MR_ZlibParams_DefaultConstructArray | ( | size_t | num_elems | ) |
Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_ZlibParams_DestroyArray(). Use MR_ZlibParams_OffsetMutablePtr() and MR_ZlibParams_OffsetPtr() to access the array elements.
| MRC_API void MR_ZlibParams_Destroy | ( | const MR_ZlibParams * | _this | ) |
Destroys a heap-allocated instance of MR_ZlibParams. Does nothing if the pointer is null.
| MRC_API void MR_ZlibParams_DestroyArray | ( | const MR_ZlibParams * | _this | ) |
Destroys a heap-allocated array of MR_ZlibParams. Does nothing if the pointer is null.
| MRC_API const bool * MR_ZlibParams_Get_rawDeflate | ( | const MR_ZlibParams * | _this | ) |
wire format of the (de)compressed bytes: true → raw deflate (RFC 1951, no wrapper) — suitable for a ZIP entry; false (default) → zlib-wrapped (RFC 1950) Returns a pointer to a member variable of class MR::ZlibParams named rawDeflate. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API bool * MR_ZlibParams_GetMutable_rawDeflate | ( | MR_ZlibParams * | _this | ) |
wire format of the (de)compressed bytes: true → raw deflate (RFC 1951, no wrapper) — suitable for a ZIP entry; false (default) → zlib-wrapped (RFC 1950) Returns a mutable pointer to a member variable of class MR::ZlibParams named rawDeflate. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.
| MRC_API MR_ZlibParams * MR_ZlibParams_OffsetMutablePtr | ( | MR_ZlibParams * | ptr, |
| ptrdiff_t | i ) |
Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.
| MRC_API const MR_ZlibParams * MR_ZlibParams_OffsetPtr | ( | const MR_ZlibParams * | ptr, |
| ptrdiff_t | i ) |
Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.
| MRC_API void MR_ZlibParams_Set_rawDeflate | ( | MR_ZlibParams * | _this, |
| bool | value ) |
wire format of the (de)compressed bytes: true → raw deflate (RFC 1951, no wrapper) — suitable for a ZIP entry; false (default) → zlib-wrapped (RFC 1950) Modifies a member variable of class MR::ZlibParams named rawDeflate. Parameter _this can not be null. It is a single object. When this function is called, this object will drop object references it held previously in rawDeflate.
1.14.0