axmol/core/renderer/CCCallbackCommand.h

/****************************************************************************
 Copyright (c) 2018-2019 Xiamen Yaji Software Co., Ltd.
 Copyright (c) 2022 Bytedance Inc.

 https://axys1.github.io/

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ****************************************************************************/
#pragma once

#include "renderer/backend/PixelBufferDescriptor.h"
#include "renderer/CCRenderCommand.h"
#include "base/CCRefPtr.h"

/**
 * @addtogroup renderer
 * @{
 */

NS_AX_BEGIN

namespace backend
{
class TextureBackend;
}

/**
Callback command is used to invoke a callback function when this command is
executed. You can do some logic opertion in the callback, such as invoking
renderer to set depth/stencil test. Don't suggest to invoke backen API in
the callback function.
*/
class AX_DLL CallbackCommand : public RenderCommand
{
    // only allow render to manage the callbackCommand
    friend class Renderer;
    CallbackCommand();
    ~CallbackCommand(){};

public:
    void init(float globalZOrder);
    void init(float globalZorder, const Mat4& transform, unsigned int);

    /**
     * @brief Reset the command state for reuse
     * 
     */
    void reset();

    /**
     Execute the render command and call callback functions.
     */
    void execute();
    /**Callback function.*/
    std::function<void()> func;
};

NS_AX_END
/**
 end of support group
 @}
 */