All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
fastCompression.h
Go to the documentation of this file.
1 //`
2 // Copyright 2017 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 
24 #ifndef PXR_BASE_TF_FAST_COMPRESSION_H
25 #define PXR_BASE_TF_FAST_COMPRESSION_H
26 
29 
30 #include "pxr/pxr.h"
31 
32 #include "pxr/base/tf/api.h"
33 
34 #include <cstddef>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 class TfFastCompression
39 {
40 public:
43  TF_API static size_t
44  GetMaxInputSize();
45 
49  TF_API static size_t
50  GetCompressedBufferSize(size_t inputSize);
51 
57  TF_API static size_t
58  CompressToBuffer(char const *input, char *compressed, size_t inputSize);
59 
63  TF_API static size_t
64  DecompressFromBuffer(char const *compressed, char *output,
65  size_t compressedSize, size_t maxOutputSize);
66 };
67 
68 
69 PXR_NAMESPACE_CLOSE_SCOPE
70 
71 #endif // PXR_BASE_TF_FAST_COMPRESSION_H
72 
73