blob: 5c2b1da07868ea9d2afd48acaa4300c3dd1f36b5 (
plain) (
blame)
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/*
* Copyright (c) 2008-2017, NVIDIA CORPORATION. All rights reserved.
*
* NVIDIA CORPORATION and its licensors retain all intellectual property
* and proprietary rights in and to this software, related documentation
* and any modifications thereto. Any use, reproduction, disclosure or
* distribution of this software and related documentation without an express
* license agreement from NVIDIA CORPORATION is strictly prohibited.
*/
#ifndef RENDER_DEBUG_INTERFACE_H
#define RENDER_DEBUG_INTERFACE_H
/*!
\file
\brief debug rendering classes and structures
*/
#include "ApexDefs.h"
#include "RenderDebugTyped.h" // include the header file containing the base class
#include "ApexInterface.h"
#include "Renderable.h"
#if PX_PHYSICS_VERSION_MAJOR == 3
#include "common/PxRenderBuffer.h"
#endif
/// Macros for getting render debug interface for argument
#define RENDER_DEBUG_IFACE(ptr) ((ptr)->getRenderDebugInterface())
namespace nvidia
{
namespace apex
{
class UserRenderer;
class UserRenderResourceManager;
PX_PUSH_PACK_DEFAULT
#if PX_PHYSICS_VERSION_MAJOR == 3
/**
\brief This is a helper class implementation of PxRenderBuffer that holds the counts
and pointers for renderable data. Does not own the memory, simply used to transfer
the state. The append method is not supported.
*/
class PhysXRenderBuffer : public PxRenderBuffer
{
public:
PhysXRenderBuffer()
{
clear();
}
/**
\brief Get number of points in the render buffer
*/
virtual uint32_t getNbPoints() const
{
return mNbPoints;
}
/**
\brief Get points data
*/
virtual const PxDebugPoint* getPoints() const
{
return mPoints;
}
/**
\brief Get number of lines in the render buffer
*/
virtual uint32_t getNbLines() const
{
return mNbLines;
}
/**
\brief Get lines data
*/
virtual const PxDebugLine* getLines() const
{
return mLines;
}
/**
\brief Get number of triangles in the render buffer
*/
virtual uint32_t getNbTriangles() const
{
return mNbTriangles;
}
/**
\brief Get triangles data
*/
virtual const PxDebugTriangle* getTriangles() const
{
return mTriangles;
}
/**
\brief Get number of texts in the render buffer
*/
virtual uint32_t getNbTexts() const
{
return mNbTexts;
}
/**
\brief Get texts data
*/
virtual const PxDebugText* getTexts() const
{
return mTexts;
}
/**
\brief Append PhysX render buffer
*/
virtual void append(const PxRenderBuffer& other)
{
PX_UNUSED(other);
PX_ALWAYS_ASSERT(); // this method not implemented!
}
/**
\brief Clear this buffer
*/
virtual void clear()
{
mNbPoints = 0;
mPoints = NULL;
mNbLines = 0;
mLines = NULL;
mNbTriangles = 0;
mTriangles = NULL;
mNbTexts = 0;
mTexts = NULL;
}
/**
\brief Number of points
*/
uint32_t mNbPoints;
/**
\brief Points data
*/
PxDebugPoint *mPoints;
/**
\brief Number of lines
*/
uint32_t mNbLines;
/**
\brief Lines data
*/
PxDebugLine *mLines;
/**
\brief Number of triangles
*/
uint32_t mNbTriangles;
/**
\brief Triangles data
*/
PxDebugTriangle *mTriangles;
/**
\brief Number of texts
*/
uint32_t mNbTexts;
/**
\brief Text data
*/
PxDebugText *mTexts;
};
#endif
/**
\brief wrapper for DebugRenderable
*/
class RenderDebugInterface : public ApexInterface, public Renderable
{
public:
/**
\brief Method to support rendering to a legacy PhysX SDK DebugRenderable object instead
of to the APEX Render Resources API (i.e.: Renderable).
This method is used to enable or disable the use of a legacy DebugRenderable. When enabled,
use the getDebugRenderable() method to get a legacy DebugRenerable object that will contain
all the debug output.
*/
virtual void setUseDebugRenderable(bool state) = 0;
#if PX_PHYSICS_VERSION_MAJOR == 3
/**
\brief Method to support rendering to a legacy PhysX SDK PxRenderBuffer object instead
of to the APEX Render Resources API (i.e.: Renderable).
When enabled with a call to setUseDebugRenderable(true), this method will return a legacy
PxRenderBuffer object that contains all of the output of the RenderDebug class.
*/
virtual void getRenderBuffer(PhysXRenderBuffer& renderable) = 0;
/**
\brief Method to support rendering to a legacy PhysX SDK PxRenderBuffer object instead
of to the APEX Render Resources API (i.e.: Renderable). Lines and triangle in
screen space
When enabled with a call to setUseDebugRenderable(true), this method will return a legacy
PxRenderBuffer object that contains all of the output of the RenderDebug class.
*/
virtual void getRenderBufferScreenSpace(PhysXRenderBuffer& renderable) = 0;
/**
\brief Method to support rendering from an existing PhysX SDK PxRenderBuffer object.
The contents of the PxRenderBuffer is added to the current contents of the
RenderDebug object, and is output through the APEX Render Resources API.
*/
virtual void addDebugRenderable(const physx::PxRenderBuffer& renderBuffer) = 0;
#endif //PX_PHYSICS_VERSION_MAJOR == 3
virtual void release() = 0;
/**
\brief Returns render debug interface RENDER_DEBUG::RenderDebugTyped
*/
virtual RENDER_DEBUG::RenderDebugTyped* getRenderDebugInterface() = 0;
protected:
virtual ~RenderDebugInterface(void) { };
};
PX_POP_PACK
}
} // end namespace nvidia::apex
#endif // RENDER_DEBUG_INTERFACE_H
|