SurfaceHandler.h

Go to the documentation of this file.

/*********************************************************\
 *  File: SurfaceHandler.h                               *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLRENDERER_SURFACE_HANDLER_H__
#define __PLRENDERER_SURFACE_HANDLER_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLRenderer/PLRenderer.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLRenderer {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class Surface;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    A renderer surface handler will be informed automatically
*    if it's renderer surface is destroyed
*/
class SurfaceHandler {


    //[-------------------------------------------------------]
    //[ Friends                                               ]
    //[-------------------------------------------------------]
    friend class Surface;


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        */
        PLRENDERER_API SurfaceHandler();

        /**
        *  @brief
        *    Copy constructor
        *
        *  @param[in] cSource
        *    Source to copy from
        */
        PLRENDERER_API SurfaceHandler(const SurfaceHandler &cSource);

        /**
        *  @brief
        *    Destructor
        */
        PLRENDERER_API ~SurfaceHandler();

        /**
        *  @brief
        *    Copy operator
        *
        *  @param[in] cSource
        *    Source to copy from
        *
        *  @return
        *    Reference to this instance
        */
        PLRENDERER_API SurfaceHandler &operator =(const SurfaceHandler &cSource);

        /**
        *  @brief
        *    Returns the renderer surface of this handler
        *
        *  @return
        *    The renderer surface of this handler, can be a null pointer
        */
        inline Surface *GetSurface() const;

        /**
        *  @brief
        *    Set the renderer surface of this handler
        *
        *  @param[in] pSurface
        *    The renderer surface of this handler, can be a null pointer
        */
        PLRENDERER_API void SetSurface(Surface *pSurface = nullptr);


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        Surface *m_pSurface;    /**< The renderer handlers surface, can be a null pointer */


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLRenderer


//[-------------------------------------------------------]
//[ Implementation                                        ]
//[-------------------------------------------------------]
#include "PLRenderer/Renderer/SurfaceHandler.inl"


#endif // __PLRENDERER_SURFACE_HANDLER_H__