nvperfapi_config.h File Reference

#include "nvperfapi_common_types.h"

Go to the source code of this file.


Config object

NVPA_Status NVPA_Config_Create (NVPA_Activity *pActivity, NVPA_Config **ppConfig)
NVPA_Status NVPA_Config_Acquire (const NVPA_Config *pConfig)
NVPA_Status NVPA_Config_Release (const NVPA_Config *pConfig)
NVPA_Status NVPA_Config_GetNumEnabledMetrics (const NVPA_Config *pConfig, size_t *pNumEnabledMetrics)
NVPA_Status NVPA_Config_GetEnabledMetricsSerialized (const NVPA_Config *pConfig, size_t numSerialized, NVPA_Bool *pSerialized, size_t *pNumSerialized)
NVPA_Status NVPA_Config_GetEnabledMetricIds (const NVPA_Config *pConfig, size_t numMetricIds, NVPA_MetricId *pMetricIds, size_t *pNumMetricIds)

Detailed Description


Function Documentation

NVPA_Status NVPA_Config_Acquire ( const NVPA_Config pConfig  ) 

Increments refcount on pConfig.

NVPA_Status NVPA_Config_Create ( NVPA_Activity pActivity,
NVPA_Config **  ppConfig 
)

Creates a Config object from an Activity.

Parameters:
[in] pActivity 
[out] ppConfig Newly created NVPA_Config objects have a refcount of 1. Release the refcount by calling NVPA_Config_Release().
It is safe to destroy pActivity after this call.

NVPA_Status NVPA_Config_GetEnabledMetricIds ( const NVPA_Config pConfig,
size_t  numMetricIds,
NVPA_MetricId pMetricIds,
size_t *  pNumMetricIds 
)

Returns the name of each enabled metric.

Parameters:
[in] pConfig 
[in] numMetricIds 
[out] pMetricIds points to an array of numMetricIds elements
[out] pNumMetricIds may be NULL; the number of MetricIds written to pMetricIds

NVPA_Status NVPA_Config_GetEnabledMetricsSerialized ( const NVPA_Config pConfig,
size_t  numSerialized,
NVPA_Bool pSerialized,
size_t *  pNumSerialized 
)

Returns the serialized flag for each enabled metric.

The serialized flag is set by NVPA_MetricOptions_SetSerialized().

Parameters:
[in] pConfig 
[in] numSerialized 
[out] pSerialized points to an array of numSerialized elements
[out] pNumSerialized may be NULL; the number of MetricIds written to pSerialized

NVPA_Status NVPA_Config_GetNumEnabledMetrics ( const NVPA_Config pConfig,
size_t *  pNumEnabledMetrics 
)

Returns the number of enabled metrics.

NVPA_Status NVPA_Config_Release ( const NVPA_Config pConfig  ) 

Decrements refcount on pConfig.

When an object's refcount reaches 0, it is destroyed.


NVIDIA(R) PerfWorks SDK Documentation (c) 2015-2016. NVIDIA Corporation. All Rights Reserved.