Struct ggez::graphics::GlBackendSpec

pub struct GlBackendSpec { /* fields omitted */ }

A backend specification for OpenGL. This is different from Backend because this needs to be its own struct to implement traits upon, and because there may need to be a layer of translation between what the user asks for in the config, and what the graphics backend code actually gets from the driver.

You shouldn't normally need to fiddle with this directly but it has to be public because generic types like Shader depend on it.

Trait Implementations

impl BackendSpec for GlBackendSpec

type Resources = Resources

gfx resource type

type Factory = Factory

gfx factory type

type CommandBuffer = CommandBuffer

gfx command buffer type

type Device = Device

gfx device type

pub fn version_tuple(&self) -> (u8, u8)

Returns the version of the backend, (major, minor).

pub fn api(&self) -> Api

Returns the glutin Api enum for this backend.

pub fn shaders(&self) -> (&'static [u8], &'static [u8])

Returns the text of the vertex and fragment shader files to create default shaders for this backend.

pub fn init<'a>(
    &self,
    window_builder: WindowBuilder,
    gl_builder: ContextBuilder<'a, NotCurrent>,
    events_loop: &EventLoop<()>,
    color_format: Format,
    depth_format: Format
) -> Result<(WindowedContext<PossiblyCurrent>, Self::Device, Self::Factory, RawRenderTargetView<Self::Resources>, RawDepthStencilView<Self::Resources>), CreationError>

Creates the window.

pub fn info(&self, device: &Self::Device) -> String

Returns a string containing some backend-dependent info.

pub fn encoder(
    factory: &mut Self::Factory
) -> Encoder<Self::Resources, Self::CommandBuffer>

Create an Encoder for the backend.

pub fn resize_viewport(
    &self,
    color_view: &RawRenderTargetView<Self::Resources>,
    depth_view: &RawDepthStencilView<Self::Resources>,
    color_format: Format,
    depth_format: Format,
    window: &WindowedContext<PossiblyCurrent>
) -> Option<(RawRenderTargetView<Self::Resources>, RawDepthStencilView<Self::Resources>)>

Resizes the viewport for the backend. (right now assumes a Glutin window...)

pub fn raw_to_typed_shader_resource(
    &self,
    texture_view: RawShaderResourceView<Self::Resources>
) -> ShaderResourceView<Self::Resources, [f32; 4]>

A helper function to take a RawShaderResourceView and turn it into a typed one based on the surface type defined in a BackendSpec.

pub fn raw_to_typed_texture(
    &self,
    texture_view: RawTexture<Self::Resources>
) -> Texture<Self::Resources, <Srgba8 as Formatted>::Surface>

Helper function that turns a raw to typed texture. A bit hacky since we can't really specify surface formats as part of this that well, alas. There's some functions, like gfx::Encoder::update_texture(), that don't seem to have a _raw() counterpart, so we need this, so we need BuggoSurfaceFormat to keep fixed at compile time what texture format we're actually using. Oh well!

impl Clone for GlBackendSpec

pub fn clone(&self) -> GlBackendSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for GlBackendSpec

impl Debug for GlBackendSpec

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

Formats the value using the given formatter.

impl Default for GlBackendSpec

pub fn default() -> Self

Return GlBackendSpec { major: 3, minor: 2, api: glutin :: Api :: OpenGl }

impl Eq for GlBackendSpec

impl From<Backend> for GlBackendSpec

pub fn from(c: Backend) -> Self

Performs the conversion.

impl PartialEq<GlBackendSpec> for GlBackendSpec

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

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

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

This method tests for !=.

impl StructuralEq for GlBackendSpec

impl StructuralPartialEq for GlBackendSpec