All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
asset.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 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 AR_ASSET_H
25 #define AR_ASSET_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/ar/api.h"
31 
32 #include <cstdio>
33 #include <memory>
34 #include <utility>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
43 class ArAsset {
44 public:
45  AR_API
46  virtual ~ArAsset();
47 
48  AR_API
49  ArAsset(const ArAsset&) = delete;
50 
51  AR_API
52  ArAsset& operator=(const ArAsset&) = delete;
53 
55  AR_API
56  virtual size_t GetSize() = 0;
57 
66  AR_API
67  virtual std::shared_ptr<const char> GetBuffer() = 0;
68 
71  AR_API
72  virtual size_t Read(void* buffer, size_t count, size_t offset) = 0;
73 
91  AR_API
92  virtual std::pair<FILE*, size_t> GetFileUnsafe() = 0;
93 
94 protected:
95  AR_API
96  ArAsset();
97 };
98 
99 PXR_NAMESPACE_CLOSE_SCOPE
100 
101 #endif // AR_ASSET_H
Interface for accessing the contents of an asset.
Definition: asset.h:43
virtual AR_API std::shared_ptr< const char > GetBuffer()=0
Returns a pointer to a buffer with the contents of the asset, with size given by GetSize().
virtual AR_API size_t Read(void *buffer, size_t count, size_t offset)=0
Read count bytes at offset from the beginning of the asset into buffer.
virtual AR_API size_t GetSize()=0
Returns size of the asset.
virtual AR_API std::pair< FILE *, size_t > GetFileUnsafe()=0
Returns a read-only FILE* handle and offset for this asset if available, or (nullptr, 0) otherwise.