PDG_LoopInfo.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS:
 */

#ifndef __PDG_LOOP_INFO_H__
#define __PDG_LOOP_INFO_H__

#include "PDG_API.h"
#include "PDG_Types.h"

#include <UT/UT_Array.h>

/*
 * Stores metadata for a work item that is part of a feedback loop block
 */
struct PDG_API PDG_LoopInfo
{
    /// Utility typdef for a stack of loop infos
    using Stack = UT_Array<PDG_LoopInfo>;

    /// The loop begin work item
    PDG_WorkItem*       myLoopItem;

    /// The Id used to lock services associated with this item
    PDG_WorkItemID      myServiceLock;

    /// The loop iteration
    int                 myLoopIteration;

    /// The loop number
    int                 myLoopNumber;

    /// The total number of iterations in the loop
    int                 myLoopSize;
};

#endif