RavEngine
Loading...
Searching...
No Matches
PxPvdProfileZone.h
1// Redistribution and use in source and binary forms, with or without
2// modification, are permitted provided that the following conditions
3// are met:
4// * Redistributions of source code must retain the above copyright
5// notice, this list of conditions and the following disclaimer.
6// * Redistributions in binary form must reproduce the above copyright
7// notice, this list of conditions and the following disclaimer in the
8// documentation and/or other materials provided with the distribution.
9// * Neither the name of NVIDIA CORPORATION nor the names of its
10// contributors may be used to endorse or promote products derived
11// from this software without specific prior written permission.
12//
13// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
14// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
17// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24//
25// Copyright (c) 2008-2022 NVIDIA Corporation. All rights reserved.
26
27#ifndef PX_PVD_PROFILE_ZONE_H
28#define PX_PVD_PROFILE_ZONE_H
29
30#include "foundation/PxPreprocessor.h"
31
32#include "PxProfileEventBufferClientManager.h"
33#include "PxProfileEventNames.h"
34#include "PxProfileEventSender.h"
35
36namespace physx {
37 class PxAllocatorCallback;
38
39 namespace profile {
40
41 class PxProfileZoneManager;
42
67 {
68 protected:
69 virtual ~PxProfileZone(){}
70 public:
75 virtual const char* getName() = 0;
79 virtual void release() = 0;
80
91
98 virtual uint16_t getEventIdForName( const char* inName ) = 0;
99
104 virtual void flushEventIdNameMap() = 0;
105
124 virtual uint16_t getEventIdsForNames( const char** inNames, uint32_t inLen ) = 0;
125
136 static PxProfileZone& createProfileZone(PxAllocatorCallback* inAllocator, const char* inSDKName, PxProfileNames inNames = PxProfileNames(), uint32_t inEventBufferByteSize = 0x10000 /*64k*/);
137
138 };
139} }
140
141#endif
142
Abstract base class for an application defined memory allocator that can be used by the Nv library.
Definition PxAllocatorCallback.h:53
Tagging interface to indicate an object that is capable of flushing a profile event stream at a certa...
Definition PxProfileEventSender.h:39
Sends the full events where the caller must provide the context and thread id.
Definition PxProfileEventSender.h:53
Provides a mapping from event ID -> name.
Definition PxProfileEventNames.h:74
Manager keep collections of PxProfileZoneClient clients.
Definition PxProfileEventBufferClientManager.h:69
The profiling system was setup in the expectation that there would be several systems that each had i...
Definition PxProfileZoneManager.h:86
The profiling system was setup in the expectation that there would be several systems that each had i...
Definition PxPvdProfileZone.h:67
virtual uint16_t getEventIdsForNames(const char **inNames, uint32_t inLen)=0
Reserve a contiguous set of profile event ids for a set of names.
virtual void setProfileZoneManager(PxProfileZoneManager *inMgr)=0
Set profile zone manager for the zone.
virtual const char * getName()=0
Get profile zone name.
static PxProfileZone & createProfileZone(PxAllocatorCallback *inAllocator, const char *inSDKName, PxProfileNames inNames=PxProfileNames(), uint32_t inEventBufferByteSize=0x10000)
Create a new profile zone.
Definition PxProfileEventImpl.cpp:45
virtual void release()=0
Release the profile zone.
virtual uint16_t getEventIdForName(const char *inName)=0
Get or create a new event id for a given name. If you pass in a previously defined event name (includ...
virtual void flushEventIdNameMap()=0
Specifies that it is a safe point to flush read-write name map into read-only map....
virtual PxProfileZoneManager * getProfileZoneManager()=0
Get profile zone manager for the zone.
Sorts an array of objects in ascending order, assuming that the predicate implements the < operator:
Definition PxBoxController.h:39
Aggregator of event id -> name mappings.
Definition PxProfileEventNames.h:54