Zhihu Youtube Twitter Mastodon Rss
HOME
SOFTWARE
DOCS

  • GPU Performance API
    GPU Performance API

    • GPU Performance API documentation

    Home » Manuals » GPU Performance API » API Reference » GpaEndSession

    Manuals home

  • GPU Performance API
    GPU Performance API

    • GpaEndSession

    Syntax

    Copied!

    GpaStatus GpaEndSession(
    GpaSessionId session_id);

    Description

    Ends sampling with the currently enabled set of counters. This will end the sampling process. A session must be ended before results for that session can be queried.

    Parameters

    Name

    Description

    session_id

    Unique identifier of a previously-created session.

    Return value

    Return value

    Description

    kGpaStatusOk

    The session was successfully ended.

    kGpaStatusErrorGpaNotInitialized

    GPA was not initialized. Call GpaInitialize before all other entrypoints.

    kGpaStatusErrorNullPointer

    The supplied session_id parameter is NULL.

    kGpaStatusErrorSessionNotFound

    The supplied session_id parameter was not recognized as a previously-created session identifier.

    kGpaStatusErrorVariableNumberOfSamplesInPasses

    There were an inconsistent number of samples created in each pass of the session.

    kGpaStatusErrorNotEnoughPasses

    There were not enough passes created in the session

    kGpaStatusErrorSessionNotStarted

    The session has not been started.

    kGpaStatusErrorFailed

    The session could be be ended.

    kGpaStatusErrorOtherSessionActive

    Another session is active.

    kGpaStatusErrorException

    Exception occurred.

    Related pages

    Looking for more documentation on GPUOpen?

    AMD GPUOpen software blogs

    Our handy software release blogs will help you make good use of our tools, SDKs, and effects, as well as sharing the latest features with new releases.

    GPUOpen Manuals

    Don’t miss our manual documentation! And if slide decks are what you’re after, you’ll find 100+ of our finest presentations here.

    AMD GPUOpen Performance Guides

    The home of great performance and optimization advice for AMD RDNAâ„¢ 2 GPUs, AMD Ryzenâ„¢ CPUs, and so much more.

    Getting started: AMD GPUOpen software

    New or fairly new to AMD’s tools, libraries, and effects? This is the best place to get started on GPUOpen!

    AMD GPUOpen Getting Started Development and Performance

    Looking for tips on getting started with developing and/or optimizing your game, whether on AMD hardware or generally? We’ve got you covered!

    AMD GPUOpen Technical blogs

    Browse our technical blogs, and find valuable advice on developing with AMD hardware, ray tracing, Vulkan®, DirectX®, Unreal Engine, and lots more.

    Find out more about our software!

    AMD GPUOpen Effects - AMD FidelityFX technologies

    Create wonder. No black boxes. Meet the AMD FidelityFX SDK!

    AMD GPUOpen Samples

    Browse all our useful samples. Perfect for when you’re needing to get started, want to integrate one of our libraries, and much more.

    AMD GPUOpen developer SDKs

    Discover what our SDK technologies can offer you. Query hardware or software, manage memory, create rendering applications or machine learning, and much more!

    AMD GPUOpen Developer Tools

    Analyze, Optimize, Profile, Benchmark. We provide you with the developer tools you need to make sure your game is the best it can be!