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 PXR_USD_AR_ASSET_H
25 #define PXR_USD_AR_ASSET_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/ar/ar.h"
31 #include "pxr/usd/ar/api.h"
32 
33 #include <cstdio>
34 #include <memory>
35 #include <utility>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
44 class ArAsset {
45 public:
46  AR_API
47  virtual ~ArAsset();
48 
49  ArAsset(const ArAsset&) = delete;
50  ArAsset& operator=(const ArAsset&) = delete;
51 
53  AR_API
54  virtual size_t GetSize() const = 0;
55 
64  AR_API
65  virtual std::shared_ptr<const char> GetBuffer() const = 0;
66 
72  AR_API
73  virtual size_t Read(void* buffer, size_t count, size_t offset) const = 0;
74 
92  AR_API
93  virtual std::pair<FILE*, size_t> GetFileUnsafe() const = 0;
94 
102  AR_API
103  virtual std::shared_ptr<ArAsset> GetDetachedAsset() const;
104 
105 protected:
106  AR_API
107  ArAsset();
108 };
109 
110 PXR_NAMESPACE_CLOSE_SCOPE
111 
112 #endif // PXR_USD_AR_ASSET_H
virtual AR_API std::pair< FILE *, size_t > GetFileUnsafe() const =0
Returns a read-only FILE* handle and offset for this asset if available, or (nullptr,...
Interface for accessing the contents of an asset.
Definition: asset.h:44
virtual AR_API size_t GetSize() const =0
Returns size of the asset.
virtual AR_API std::shared_ptr< ArAsset > GetDetachedAsset() const
Returns an ArAsset with the contents of this asset detached from from this asset's serialized data.
virtual AR_API std::shared_ptr< const char > GetBuffer() const =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) const =0
Read count bytes at offset from the beginning of the asset into buffer.