axmol/core/platform/ios/GLViewImpl-ios.h

/****************************************************************************
 Copyright (c) 2010-2012 cocos2d-x.org
 Copyright (c) 2013-2016 Chukong Technologies Inc.
 Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

 https://axmolengine.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 "base/Ref.h"
#include "platform/Common.h"
#include "platform/GLView.h"

NS_AX_BEGIN

/** Class that represent the OpenGL View
 */
class AX_DLL GLViewImpl : public GLView
{
public:
    /** creates a GLViewImpl with a objective-c CCEAGLViewImpl instance */
    static GLViewImpl* createWithEAGLView(void* eaGLView);

    /** creates a GLViewImpl with a title name in fullscreen mode */
    static GLViewImpl* create(std::string_view viewName);

    /** creates a GLViewImpl with a title name, a rect and the zoom factor */
    static GLViewImpl* createWithRect(std::string_view viewName, const Rect& rect, float frameZoomFactor = 1.0f);

    /** creates a GLViewImpl with a name in fullscreen mode */
    static GLViewImpl* createWithFullScreen(std::string_view viewName);

    static void convertAttrs();
    static void* _pixelFormat;
    static int _depthFormat;
    static int _multisamplingCount;

    /** sets the content scale factor */
    virtual bool setContentScaleFactor(float contentScaleFactor) override;

    /** returns the content scale factor */
    virtual float getContentScaleFactor() const override;

    /** returns whether or not the view is in Retina Display mode */
    virtual bool isRetinaDisplay() const override { return getContentScaleFactor() == 2.0; }

    /** returns the objective-c EAGLView instance */
    virtual void* getEAGLView() const override { return _eaglView; }

    // overrides
    virtual bool isOpenGLReady() override;
    virtual void end() override;
    virtual void swapBuffers() override;
    virtual void setIMEKeyboardState(bool bOpen) override;

    virtual Rect getSafeAreaRect() const override;

    void queueOperation(void (*op)(void*), void* param) override;

protected:
    GLViewImpl();
    virtual ~GLViewImpl();

    bool initWithEAGLView(void* eaGLView);
    bool initWithRect(std::string_view viewName, const Rect& rect, float frameZoomFactor);
    bool initWithFullScreen(std::string_view viewName);

    // the objective-c EAGLView instance
    void* _eaglView;
};

NS_AX_END