1//
2// Redistribution and use in source and binary forms, with or without
3// modification, are permitted provided that the following conditions
4// are met:
5// * Redistributions of source code must retain the above copyright
6// notice, this list of conditions and the following disclaimer.
7// * Redistributions in binary form must reproduce the above copyright
8// notice, this list of conditions and the following disclaimer in the
9// documentation and/or other materials provided with the distribution.
10// * Neither the name of NVIDIA CORPORATION nor the names of its
11// contributors may be used to endorse or promote products derived
12// from this software without specific prior written permission.
13//
14// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
15// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25//
26// Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.
27// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29
30#ifndef PXFOUNDATION_PXIO_H
31#define PXFOUNDATION_PXIO_H
32
33/** \addtogroup common
34 @{
35*/
36
37#include "foundation/PxSimpleTypes.h"
38
39#if !PX_DOXYGEN
40namespace physx
41{
42#endif
43
44/**
45\brief Input stream class for I/O.
46
47The user needs to supply a PxInputStream implementation to a number of methods to allow the SDK to read data.
48*/
49
50class PxInputStream
51{
52 public:
53 /**
54 \brief read from the stream. The number of bytes read may be less than the number requested.
55
56 \param[in] dest the destination address to which the data will be read
57 \param[in] count the number of bytes requested
58
59 \return the number of bytes read from the stream.
60 */
61
62 virtual uint32_t read(void* dest, uint32_t count) = 0;
63
64 virtual ~PxInputStream()
65 {
66 }
67};
68
69/**
70\brief Input data class for I/O which provides random read access.
71
72The user needs to supply a PxInputData implementation to a number of methods to allow the SDK to read data.
73*/
74
75class PxInputData : public PxInputStream
76{
77 public:
78 /**
79 \brief return the length of the input data
80
81 \return size in bytes of the input data
82 */
83
84 virtual uint32_t getLength() const = 0;
85
86 /**
87 \brief seek to the given offset from the start of the data.
88
89 \param[in] offset the offset to seek to. If greater than the length of the data, this call is equivalent to
90 seek(length);
91 */
92
93 virtual void seek(uint32_t offset) = 0;
94
95 /**
96 \brief return the current offset from the start of the data
97
98 \return the offset to seek to.
99 */
100
101 virtual uint32_t tell() const = 0;
102
103 virtual ~PxInputData()
104 {
105 }
106};
107
108/**
109\brief Output stream class for I/O.
110
111The user needs to supply a PxOutputStream implementation to a number of methods to allow the SDK to write data.
112*/
113
114class PxOutputStream
115{
116 public:
117 /**
118 \brief write to the stream. The number of bytes written may be less than the number sent.
119
120 \param[in] src the destination address from which the data will be written
121 \param[in] count the number of bytes to be written
122
123 \return the number of bytes written to the stream by this call.
124 */
125
126 virtual uint32_t write(const void* src, uint32_t count) = 0;
127
128 virtual ~PxOutputStream()
129 {
130 }
131};
132
133#if !PX_DOXYGEN
134} // namespace physx
135#endif
136
137/** @} */
138#endif // #ifndef PXFOUNDATION_PXIO_H
139

source code of qtquick3dphysics/src/3rdparty/PhysX/pxshared/include/foundation/PxIO.h