All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
filesystemAsset.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 #ifndef AR_FILESYSTEM_ASSET_H
24 #define AR_FILESYSTEM_ASSET_H
25 
27 
28 #include "pxr/pxr.h"
29 #include "pxr/usd/ar/api.h"
30 #include "pxr/usd/ar/asset.h"
31 
32 #include <cstdio>
33 #include <memory>
34 #include <utility>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
42  : public ArAsset
43 {
44 public:
48  AR_API
49  explicit ArFilesystemAsset(FILE* file);
50 
52  AR_API
54 
56  AR_API
57  virtual size_t GetSize() override;
58 
61  AR_API
62  virtual std::shared_ptr<const char> GetBuffer() override;
63 
66  AR_API
67  virtual size_t Read(void* buffer, size_t count, size_t offset) override;
68 
72  AR_API
73  virtual std::pair<FILE*, size_t> GetFileUnsafe() override;
74 
75 private:
76  FILE* _file;
77 };
78 
79 PXR_NAMESPACE_CLOSE_SCOPE
80 
81 #endif // AR_FILESYSTEM_ASSET_H
Interface for accessing the contents of an asset.
Definition: asset.h:43
virtual AR_API size_t GetSize() override
Returns the size of the file held by this object.
AR_API ~ArFilesystemAsset()
Closes the file owned by this object.
ArAsset implementation for asset represented by a file on a filesystem.
virtual AR_API std::pair< FILE *, size_t > GetFileUnsafe() override
Returns the FILE* handle this object was created with and an offset of 0, since the asset&#39;s contents ...
virtual AR_API std::shared_ptr< const char > GetBuffer() override
Creates a read-only memory map for the file held by this object and returns a pointer to the start of...
AR_API ArFilesystemAsset(FILE *file)
Constructs an ArFilesystemAsset for the given file.
virtual AR_API size_t Read(void *buffer, size_t count, size_t offset) override
Reads count bytes from the file held by this object at the given offset into buffer.