Version
menu_open
Wwise SDK 2023.1.4
AkBytesCount.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // AkBytesCount.h
28 
29 /// \file
30 /// IReadBytes / IWriteBytes implementation on a growing memory buffer. This
31 /// version uses the AK::MemoryMgr memory pools.
32 
33 #pragma once
34 
35 #include <AK/IBytes.h>
38 
39 namespace AK
40 {
42  : public AK::IReadBytes
43  {
44  public:
45 
48  const void * in_pBytes,
49  AkInt32 in_cBytes
50  );
52 
53  // IReadBytes implementation
54 
56  void * in_pData,
57  AkInt32 in_cBytes,
58  AkInt32 & out_cRead
59  );
60 
61  // Public methods
62 
64  const void * in_pBytes,
65  AkInt32 in_cBytes
66  );
67 
69 
70  private:
71  AkInt32 m_cBytes;
72  const AkUInt8 * m_pBytes;
73  AkInt32 m_cPos;
74  };
75 
77  : public AK::IWriteBuffer
78  {
79  public:
80 
83 
84  // IWriteBytes implementation
85 
87  const void * in_pData,
88  AkInt32 in_cBytes,
89  AkInt32& out_cWritten);
90 
91  // IWriteBuffer implementation
92 
93  AKSOUNDENGINE_API virtual bool Reserve(
94  AkInt32 in_cBytes
95  );
96 
97  AKSOUNDENGINE_API virtual AkInt32 Count() const;
98 
100  AkInt32 in_cBytes
101  );
102 
103  AKSOUNDENGINE_API virtual AkUInt8 * Bytes() const;
104 
106 
107  AKSOUNDENGINE_API virtual void Clear();
108 
109  template<class T>
110  bool Write(const T & in_data)
111  {
112  m_cPos += sizeof(T);
113  return true;
114  }
115 
116  private:
117  bool Grow(
118  AkInt32 in_cBytes
119  );
120 
121  AkInt32 m_cPos;
122  };
123 }
Audiokinetic namespace.
virtual AkUInt8 * Bytes() const
virtual AkUInt8 * Detach()
Return pointer to buffer and clear internal pointer.
uint8_t AkUInt8
Unsigned 8-bit integer.
int32_t AkInt32
Signed 32-bit integer.
#define AKSOUNDENGINE_API
ReadBytesSkip(const void *in_pBytes, AkInt32 in_cBytes)
virtual void Clear()
Clear the buffer contents.
virtual ~ReadBytesSkip()
bool Write(const T &in_data)
Definition: AkBytesCount.h:110
virtual ~WriteBytesCount()
virtual bool WriteBytes(const void *in_pData, AkInt32 in_cBytes, AkInt32 &out_cWritten)
virtual void SetCount(AkInt32 in_cBytes)
Set number of bytes written.
virtual bool ReadBytes(void *in_pData, AkInt32 in_cBytes, AkInt32 &out_cRead)
void Attach(const void *in_pBytes, AkInt32 in_cBytes)
virtual AkInt32 Count() const
virtual bool Reserve(AkInt32 in_cBytes)

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise