NvBlastTkGroup.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and 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.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016-2020 NVIDIA Corporation. All rights reserved.


#ifndef NVBLASTTKGROUP_H
#define NVBLASTTKGROUP_H

#include "NvBlastTkIdentifiable.h"


namespace Nv
{
namespace Blast
{

// Forward declarations
class TkActor;


struct TkGroupDesc
{
    uint32_t        workerCount;            
};


struct TkGroupStats
{
    NvBlastTimers   timers;                 
    uint32_t        processedActorsCount;   
    int64_t         workerTime;             
};


class TkGroupWorker
{
public:
    virtual void    process(uint32_t jobId) = 0;
};


class TkGroup : public TkIdentifiable
{
public:
    virtual bool            addActor(TkActor& actor) = 0;

    virtual uint32_t        getActorCount() const = 0;

    virtual uint32_t        getActors(TkActor** buffer, uint32_t bufferSize, uint32_t indexStart = 0) const = 0;

    virtual uint32_t        startProcess() = 0;

    virtual bool            endProcess() = 0;

    virtual void            setWorkerCount(uint32_t workerCount) = 0;

    virtual uint32_t        getWorkerCount() const = 0;

    virtual TkGroupWorker*  acquireWorker() = 0;

    virtual void            returnWorker(TkGroupWorker*) = 0;

            void            process();

    virtual void            getStats(TkGroupStats& stats) const = 0;
};

} // namespace Blast
} // namespace Nv


NV_INLINE void Nv::Blast::TkGroup::process()
{
    uint32_t jobCount = startProcess();
    if (jobCount > 0)
    {
        TkGroupWorker* worker = acquireWorker();
        for (uint32_t i = 0; i < jobCount; i++)
        {
            worker->process(i);
        }
        returnWorker(worker);
    }
    endProcess();
}


#endif // ifndef NVBLASTTKGROUP_H