mirror of
https://github.com/SFML/SFML.git
synced 2024-11-25 12:51:05 +08:00
105 lines
4.2 KiB
C++
105 lines
4.2 KiB
C++
////////////////////////////////////////////////////////////
|
|
//
|
|
// SFML - Simple and Fast Multimedia Library
|
|
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
|
|
//
|
|
// This software is provided 'as-is', without any express or implied warranty.
|
|
// In no event will the authors be held liable for any damages arising from the use of this software.
|
|
//
|
|
// Permission is granted to anyone to use this software for any purpose,
|
|
// including commercial applications, and to alter it and redistribute it freely,
|
|
// subject to the following restrictions:
|
|
//
|
|
// 1. The origin of this software must not be misrepresented;
|
|
// you must not claim that you wrote the original software.
|
|
// If you use this software in a product, an acknowledgment
|
|
// in the product documentation would be appreciated but is not required.
|
|
//
|
|
// 2. Altered source versions must be plainly marked as such,
|
|
// and must not be misrepresented as being the original software.
|
|
//
|
|
// 3. This notice may not be removed or altered from any source distribution.
|
|
//
|
|
////////////////////////////////////////////////////////////
|
|
|
|
#ifndef SFML_CONTEXTSETTINGS_HPP
|
|
#define SFML_CONTEXTSETTINGS_HPP
|
|
|
|
|
|
namespace sf
|
|
{
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Structure defining the settings of the OpenGL
|
|
/// context attached to a window
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
struct ContextSettings
|
|
{
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Default constructor
|
|
///
|
|
/// \param depth Depth buffer bits
|
|
/// \param stencil Stencil buffer bits
|
|
/// \param antialiasing Antialiasing level
|
|
/// \param major Major number of the context version
|
|
/// \param minor Minor number of the context version
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
explicit ContextSettings(unsigned int depth = 0, unsigned int stencil = 0, unsigned int antialiasing = 0, unsigned int major = 2, unsigned int minor = 0) :
|
|
DepthBits (depth),
|
|
StencilBits (stencil),
|
|
AntialiasingLevel(antialiasing),
|
|
MajorVersion (major),
|
|
MinorVersion (minor)
|
|
{
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Member data
|
|
////////////////////////////////////////////////////////////
|
|
unsigned int DepthBits; ///< Bits of the depth buffer
|
|
unsigned int StencilBits; ///< Bits of the stencil buffer
|
|
unsigned int AntialiasingLevel; ///< Level of antialiasing
|
|
unsigned int MajorVersion; ///< Major number of the context version to create
|
|
unsigned int MinorVersion; ///< Minor number of the context version to create
|
|
};
|
|
|
|
} // namespace sf
|
|
|
|
|
|
#endif // SFML_CONTEXTSETTINGS_HPP
|
|
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \class sf::ContextSettings
|
|
/// \ingroup window
|
|
///
|
|
/// ContextSettings allows to define several advanced settings
|
|
/// of the OpenGL context attached to a window. All these
|
|
/// settings have no impact on the regular SFML rendering
|
|
/// (graphics module) -- except the anti-aliasing level, so
|
|
/// you may need to use this structure only if you're using
|
|
/// SFML as a windowing system for custom OpenGL rendering.
|
|
///
|
|
/// The DepthBits and StencilBits members define the number
|
|
/// of bits per pixel requested for the (respectively) depth
|
|
/// and stencil buffers.
|
|
///
|
|
/// AntialiasingLevel represents the requested number of
|
|
/// multisampling levels for anti-aliasing.
|
|
///
|
|
/// MajorVersion and MinorVersion define the version of the
|
|
/// OpenGL context that you want. Only versions greater or
|
|
/// equal to 3.0 are relevant; versions lesser than 3.0 are
|
|
/// all handled the same way (i.e. you can use any version
|
|
/// < 3.0 if you don't want an OpenGL 3 context).
|
|
///
|
|
/// Please note that these values are only a hint.
|
|
/// No failure will be reported if one or more of these values
|
|
/// are not supported by the system; instead, SFML will try to
|
|
/// find the closest valid match. You can then retrieve the
|
|
/// settings that the window actually used to create its context,
|
|
/// with Window::GetSettings().
|
|
///
|
|
////////////////////////////////////////////////////////////
|