Struct sfml::window::ContextSettings

#[repr(C)]
pub struct ContextSettings {
    pub depth_bits: c_uint,
    pub stencil_bits: c_uint,
    pub antialiasing_level: c_uint,
    pub major_version: c_uint,
    pub minor_version: c_uint,
    pub attribute_flags: u32,
    pub srgb_capable: bool,
}

Structure defining the settings of the OpenGL context attached to a window.

ContextSettings allows to define several advanced settings of the OpenGL context attached to a window.

All these settings with the exception of the compatibility flag and anti-aliasing level have no impact on the regular SFML rendering (graphics module), so you may need to use this structure only if you’re using SFML as a windowing system for custom OpenGL rendering.

The depth_bits and stencil_bits members define the number of bits per pixel requested for the (respectively) depth and stencil buffers.

antialiasing_level represents the requested number of multisampling levels for anti-aliasing.

major_version and minor_version 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).

When requesting a context with a version greater or equal to 3.2, you have the option of specifying whether the context should follow the core or compatibility profile of all newer (>= 3.2) OpenGL specifications. For versions 3.0 and 3.1 there is only the core profile. By default a compatibility context is created. You only need to specify the core flag if you want a core profile context to use with your own OpenGL rendering. Warning: The graphics module will not function if you request a core profile context. Make sure the attributes are set to Default if you want to use the graphics module.

Setting the debug attribute flag will request a context with additional debugging features enabled. Depending on the system, this might be required for advanced OpenGL debugging. OpenGL debugging is disabled by default.

Special Note for OS X: Apple only supports choosing between either a legacy context (OpenGL 2.1) or a core context (OpenGL version depends on the operating system version but is at least 3.2). Compatibility contexts are not supported. Further information is available on the OpenGL Capabilities Tables page. OS X also currently does not support debug contexts.

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::settings.

Fields

depth_bits: c_uint

Bits of the depth buffer.

stencil_bits: c_uint

Bits of the stencil buffer.

antialiasing_level: c_uint

Level of antialiasing.

major_version: c_uint

Major number of the context version to create.

minor_version: c_uint

Minor number of the context version to create.

attribute_flags: u32

The attribute flags to create the context with.

srgb_capable: bool

Whether the context framebuffer is sRGB capable.

Implementations

impl ContextSettings

pub const ATTRIB_DEFAULT: u32 = 0u32

Non-debug, compatibility context (this and the core attribute are mutually exclusive).

pub const ATTRIB_CORE: u32 = 1u32

Core attribute.

pub const ATTRIB_DEBUG: u32 = 4u32

Debug attribute.

Trait Implementations

impl Clone for sfContextSettings

fn clone(&self) -> sfContextSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for sfContextSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ContextSettings

fn default() -> Self

Creates a ContextSettings with the following values:

• Depth bits: 0
• Stencil bits: 0
• Antialiasing level: 0
• Major version: 1
• Minor version: 1
• Attribute flags: ATTRIB_DEFAULT
• SRGB capable: false

impl Ord for sfContextSettings

fn cmp(&self, other: &sfContextSettings) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<sfContextSettings> for sfContextSettings

fn eq(&self, other: &sfContextSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<sfContextSettings> for sfContextSettings

fn partial_cmp(&self, other: &sfContextSettings) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for sfContextSettings

impl Eq for sfContextSettings

impl StructuralEq for sfContextSettings

impl StructuralPartialEq for sfContextSettings