GraphicsException.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Graphics
File: GraphicsException
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include "Base/Headers/Exception.hpp"
#include "Base/Headers/Translator.h"
#include "Base/Headers/ApplicationResource.h"
 
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A common exeption thrown when an issue occurs within the NDEVR Graphics Engine.
    **/
    class NDEVR_GRAPHICS_API GraphicsException : public Exception
    {
    public:
        enum GraphicsExceptionType
        {
            e_general
            , e_device_lost
        };
        explicit GraphicsException(const TranslatedString& error);
        GraphicsException(const TranslatedString& error, const TranslatedString& category);
        void setType(GraphicsExceptionType type);
        GraphicsExceptionType type() const;
        void setMessage(const TranslatedString& message) final override;
    protected:
        GraphicsExceptionType m_type;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A specific type of Exception that occurs when a GraphicsDevice is lost. This typically requires
        a complete re-initialization of the NDEVR Graphics Engine.
    **/
    class DeviceLostException : public GraphicsException
    {
    public:
        explicit DeviceLostException(const TranslatedString& error);
        DeviceLostException(const TranslatedString& error, const TranslatedString& category);
    };
}