HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
writableAsset.h
Go to the documentation of this file.
1 //
2 // Copyright 2020 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_WRITABLE_ASSET_H
25 #define PXR_USD_AR_WRITABLE_ASSET_H
26 
27 /// \file ar/writableAsset.h
28 
29 #include "pxr/pxr.h"
30 
31 #include "pxr/usd/ar/api.h"
32 
33 #include <cstdio>
34 
36 
37 /// \class ArWritableAsset
38 ///
39 /// Interface for writing data to an asset.
40 ///
41 /// \see ArResolver::OpenAssetForWrite for how to retrieve instances of
42 /// this object.
44 {
45 public:
46  AR_API
47  virtual ~ArWritableAsset();
48 
49  ArWritableAsset(const ArWritableAsset&) = delete;
50  ArWritableAsset& operator=(const ArWritableAsset&) = delete;
51 
52  /// Close this asset, performing any necessary finalization or commits
53  /// of data that was previously written. Returns true on success, false
54  /// otherwise.
55  ///
56  /// If successful, reads to the written asset in the same process should
57  /// reflect the fully written state by the time this function returns.
58  /// Also, further calls to any functions on this interface are invalid.
59  virtual bool Close() = 0;
60 
61  /// Writes \p count bytes from \p buffer at \p offset from the beginning
62  /// of the asset. Returns number of bytes written, or 0 on error.
63  virtual size_t Write(const void* buffer, size_t count, size_t offset) = 0;
64 
65 protected:
66  AR_API
68 };
69 
71 
72 #endif
AR_API ArWritableAsset()
#define AR_API
Definition: api.h:40
Definition: core.h:760
ArWritableAsset & operator=(const ArWritableAsset &)=delete
virtual AR_API ~ArWritableAsset()
GLint GLsizei count
Definition: glcorearb.h:405
virtual size_t Write(const void *buffer, size_t count, size_t offset)=0
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
GLintptr offset
Definition: glcorearb.h:665
virtual bool Close()=0