ios_project/proj.ios_mac/cocos2d-x/cocos/renderer/gfx/RenderBuffer.h

/****************************************************************************
 Copyright (c) 2018 Xiamen Yaji Software Co., Ltd.

 http://www.cocos2d-x.org
 
 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 "../Macro.h"
#include "renderer/Types.h"

#include "RenderTarget.h"

RENDERER_BEGIN

/**
 * @addtogroup gfx
 * @{
 */

class DeviceGraphics;

/**
 * RenderBuffer manages the GL render buffer.
 * A render buffer stores data such as an image, or can be source or target of a rendering operation.
 */
class RenderBuffer final : public RenderTarget
{
public:
    /**
     * RenderBuffer's pixel format
     */
    enum class Format : uint32_t
    {
        RGBA4 = GL_RGBA4,
        RGB5_A1 = GL_RGB5_A1,
        D16 = GL_DEPTH_COMPONENT16,
        S8 = GL_STENCIL_INDEX8,
//        D24S8 = GL_DEPTH_STENCIL
    };

    /**
     * Creates a RenderBuffer with device, pixel format and size
     */
    RENDERER_DEFINE_CREATE_METHOD_4(RenderBuffer, init,  DeviceGraphics*, Format, uint16_t, uint16_t)

    RenderBuffer();
    virtual ~RenderBuffer();

    /**
     * Initializes a RenderBuffer with device, pixel format and size
     */
    bool init(DeviceGraphics* device, Format format, uint16_t width, uint16_t height);

private:
    DeviceGraphics* _device;
    Format _format;
    uint16_t _width;
    uint16_t _height;
};

// end of gfx group
/// @}

RENDERER_END