HDK
 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 PXR_USD_AR_FILESYSTEM_ASSET_H
24 #define PXR_USD_AR_FILESYSTEM_ASSET_H
25 
26 /// \file ar/filesystemAsset.h
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 
37 
38 /// \class ArFilesystemAsset
39 ///
40 /// ArAsset implementation for asset represented by a file on a filesystem.
42  : public ArAsset
43 {
44 public:
45  /// Constructs an ArFilesystemAsset for the given \p file.
46  /// The ArFilesystemAsset object takes ownership of \p file and will
47  /// close the file handle on destruction.
48  AR_API
49  explicit ArFilesystemAsset(FILE* file);
50 
51  /// Closes the file owned by this object.
52  AR_API
54 
55  /// Returns the size of the file held by this object.
56  AR_API
57  virtual size_t GetSize() override;
58 
59  /// Creates a read-only memory map for the file held by this object
60  /// and returns a pointer to the start of the mapped contents.
61  AR_API
62  virtual std::shared_ptr<const char> GetBuffer() override;
63 
64  /// Reads \p count bytes from the file held by this object at the
65  /// given \p offset into \p buffer.
66  AR_API
67  virtual size_t Read(void* buffer, size_t count, size_t offset) override;
68 
69  /// Returns the FILE* handle this object was created with and an offset
70  /// of 0, since the asset's contents are located at the beginning of the
71  /// file.
72  AR_API
73  virtual std::pair<FILE*, size_t> GetFileUnsafe() override;
74 
75 private:
76  FILE* _file;
77 };
78 
80 
81 #endif // PXR_USD_AR_FILESYSTEM_ASSET_H
virtual AR_API size_t GetSize() override
Returns the size of the file held by this object.
virtual AR_API size_t Read(void *buffer, size_t count, size_t offset) override
Definition: asset.h:43
#define AR_API
Definition: api.h:40
GLuint buffer
Definition: glew.h:1680
AR_API ArFilesystemAsset(FILE *file)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
virtual AR_API std::shared_ptr< const char > GetBuffer() override
GLuint GLuint GLsizei count
Definition: glew.h:1253
virtual AR_API std::pair< FILE *, size_t > GetFileUnsafe() override
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
AR_API ~ArFilesystemAsset()
Closes the file owned by this object.
GLintptr offset
Definition: glew.h:1682