1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of NVIDIA CORPORATION nor the names of its
// contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.
#ifndef USER_RENDER_RESOURCE_MANAGER_H
#define USER_RENDER_RESOURCE_MANAGER_H
/*!
\file
\brief class UserRenderResourceManager, structs RenderPrimitiveType, RenderBufferHint, and RenderCullMode
*/
#include "ApexUsingNamespace.h"
namespace nvidia
{
namespace apex
{
PX_PUSH_PACK_DEFAULT
class UserRenderVertexBuffer;
class UserRenderVertexBufferDesc;
class UserRenderIndexBuffer;
class UserRenderIndexBufferDesc;
class UserRenderSurfaceBuffer;
class UserRenderSurfaceBufferDesc;
class UserRenderBoneBuffer;
class UserRenderBoneBufferDesc;
class UserRenderInstanceBuffer;
class UserRenderInstanceBufferDesc;
class UserRenderSpriteBuffer;
class UserRenderSpriteBufferDesc;
class UserRenderResource;
class UserRenderResourceDesc;
class UserOpaqueMesh;
class UserOpaqueMeshDesc;
class UserRenderSpriteTextureDesc;
/**
\brief Describe the implied vertex ordering
*/
struct RenderPrimitiveType
{
/**
\brief Enum of the implied vertex ordering types
*/
enum Enum
{
UNKNOWN = 0,
TRIANGLES,
TRIANGLE_STRIP,
LINES,
LINE_STRIP,
POINTS,
POINT_SPRITES,
};
};
/**
\brief Possible triangle culling modes
*/
struct RenderCullMode
{
/**
\brief Enum of possible triangle culling mode types
*/
enum Enum
{
CLOCKWISE = 0,
COUNTER_CLOCKWISE,
NONE
};
};
/**
\brief Hint of the buffer data lifespan
*/
struct RenderBufferHint
{
/**
\brief Enum of hints of the buffer data lifespan
*/
enum Enum
{
STATIC = 0,
DYNAMIC,
STREAMING,
};
};
/**
\brief User defined renderable resource manager
A render resource manager is an object that creates and manages renderable resources...
This is given to the APEX SDK at creation time via the descriptor and must be persistent through the lifetime
of the SDK.
*/
class UserRenderResourceManager
{
public:
virtual ~UserRenderResourceManager() {}
/**
The create methods in this class will only be called from the context of an Renderable::updateRenderResources()
call, but the release methods can be triggered by any APEX API call that deletes an Actor. It is up to
the end-user to make the release methods thread safe.
*/
virtual UserRenderVertexBuffer* createVertexBuffer(const UserRenderVertexBufferDesc& desc) = 0;
/** \brief Release vertex buffer */
virtual void releaseVertexBuffer(UserRenderVertexBuffer& buffer) = 0;
/** \brief Create index buffer */
virtual UserRenderIndexBuffer* createIndexBuffer(const UserRenderIndexBufferDesc& desc) = 0;
/** \brief Release index buffer */
virtual void releaseIndexBuffer(UserRenderIndexBuffer& buffer) = 0;
/** \brief Create bone buffer */
virtual UserRenderBoneBuffer* createBoneBuffer(const UserRenderBoneBufferDesc& desc) = 0;
/** \brief Release bone buffer */
virtual void releaseBoneBuffer(UserRenderBoneBuffer& buffer) = 0;
/** \brief Create instance buffer */
virtual UserRenderInstanceBuffer* createInstanceBuffer(const UserRenderInstanceBufferDesc& desc) = 0;
/** \brief Release instance buffer */
virtual void releaseInstanceBuffer(UserRenderInstanceBuffer& buffer) = 0;
/** \brief Create sprite buffer */
virtual UserRenderSpriteBuffer* createSpriteBuffer(const UserRenderSpriteBufferDesc& desc) = 0;
/** \brief Release sprite buffer */
virtual void releaseSpriteBuffer(UserRenderSpriteBuffer& buffer) = 0;
/** \brief Create surface buffer */
virtual UserRenderSurfaceBuffer* createSurfaceBuffer(const UserRenderSurfaceBufferDesc& desc) = 0;
/** \brief Release surface buffer */
virtual void releaseSurfaceBuffer(UserRenderSurfaceBuffer& buffer) = 0;
/** \brief Create resource */
virtual UserRenderResource* createResource(const UserRenderResourceDesc& desc) = 0;
/**
releaseResource() should not release any of the included buffer pointers. Those free methods will be
called separately by the APEX SDK before (or sometimes after) releasing the UserRenderResource.
*/
virtual void releaseResource(UserRenderResource& resource) = 0;
/**
Get the maximum number of bones supported by a given material. Return 0 for infinite.
For optimal rendering, do not limit the bone count (return 0 from this function).
*/
virtual uint32_t getMaxBonesForMaterial(void* material) = 0;
/** \brief Get the sprite layout data
Returns true in case textureDescArray is set.
In case user is not interested in setting specific layout for sprite PS,
this function should return false.
*/
virtual bool getSpriteLayoutData(uint32_t spriteCount, uint32_t spriteSemanticsBitmap, UserRenderSpriteBufferDesc* textureDescArray) = 0;
/** \brief Get the instance layout data
Returns true in case textureDescArray is set.
In case user is not interested in setting specific layout for sprite PS,
this function should return false.
*/
virtual bool getInstanceLayoutData(uint32_t spriteCount, uint32_t spriteSemanticsBitmap, UserRenderInstanceBufferDesc* instanceDescArray) = 0;
};
PX_POP_PACK
}
} // end namespace nvidia::apex
#endif
|