This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/blender/compositor/intern/COM_WorkPackage.h
Campbell Barton c434782e3a File headers: SPDX License migration
Use a shorter/simpler license convention, stops the header taking so
much space.

Follow the SPDX license specification: https://spdx.org/licenses

- C/C++/objc/objc++
- Python
- Shell Scripts
- CMake, GNUmakefile

While most of the source tree has been included

- `./extern/` was left out.
- `./intern/cycles` & `./intern/atomic` are also excluded because they
  use different header conventions.

doc/license/SPDX-license-identifiers.txt has been added to list SPDX all
used identifiers.

See P2788 for the script that automated these edits.

Reviewed By: brecht, mont29, sergey

Ref D14069
2022-02-11 09:14:36 +11:00

63 lines
1.2 KiB
C++

/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2011 Blender Foundation. */
#pragma once
#ifdef WITH_CXX_GUARDEDALLOC
# include "MEM_guardedalloc.h"
#endif
#include "COM_Enums.h"
#include "DNA_vec_types.h"
#include <functional>
#include <ostream>
namespace blender::compositor {
/* Forward Declarations. */
class ExecutionGroup;
/**
* \brief contains data about work that can be scheduled
* \see WorkScheduler
*/
struct WorkPackage {
eWorkPackageType type;
eWorkPackageState state = eWorkPackageState::NotScheduled;
/**
* \brief execution_group with the operations-setup to be evaluated
*/
ExecutionGroup *execution_group;
/**
* \brief number of the chunk to be executed
*/
unsigned int chunk_number;
/**
* Area of the execution group that the work package calculates.
*/
rcti rect;
/**
* Custom function to execute when work package type is CustomFunction.
*/
std::function<void()> execute_fn;
/**
* Called when work execution is finished.
*/
std::function<void()> executed_fn;
#ifdef WITH_CXX_GUARDEDALLOC
MEM_CXX_CLASS_ALLOC_FUNCS("COM:WorkPackage")
#endif
};
std::ostream &operator<<(std::ostream &os, const WorkPackage &work_package);
} // namespace blender::compositor