Struct dx::platform::core::Renderer

source · [−]

pub struct Renderer { /* private fields */ }

Implementations

source

impl Renderer

source

pub fn new() -> Renderer

Instantiates a new (unconnected) Renderer object:: A Renderer represents a means to render. It encapsulates the selection of an underlying driver, such as OpenGL or OpenGL-ES and a selection of a window system binding API such as GLX, or EGL or WGL.

While the renderer is unconnected it can be configured so that applications may specify backend constraints, such as “must use x11” for example via Renderer::add_constraint.

There are also some platform specific configuration apis such as xlib_renderer_set_foreign_display that may also be used while the renderer is unconnected.

Once the renderer has been configured, then it may (optionally) be explicitly connected using Renderer::connect which allows errors to be handled gracefully and potentially fallback configurations can be tried out if there are initial failures.

If a renderer is not explicitly connected then Display::new will automatically connect the renderer for you. If you don’t have any code to deal with error/fallback situations then its fine to just let do the connection for you.

Once you have setup your renderer then the next step is to create a Display using Display::new.

Many applications don’t need to explicitly use Renderer::new or Display::new and can just jump straight to Context::new and pass a None display argument so will automatically connect and setup a renderer and display.

Returns

A newly created Renderer.

source

pub fn add_constraint(&self, constraint: RendererConstraint)

This adds a renderer selection constraint.

Applications should ideally minimize how many of these constraints they depend on to ensure maximum portability.

`constraint`

A RendererConstraint to add

source

pub fn check_onscreen_template(
&self,
onscreen_template: &OnscreenTemplate
) -> bool

Tests if a given onscreen_template can be supported with the given self.

`onscreen_template`

A OnscreenTemplate

Returns

true if the onscreen_template can be supported, else false.

source

pub fn connect(&self) -> bool

Connects the configured self. Renderer connection isn’t a very active process, it basically just means validating that any given constraint criteria can be satisfied and that a usable driver and window system backend can be found.

Returns

true if there was no error while connecting the given self. false if there was an error.

source

pub fn foreach_output<P: FnMut(&Output)>(&self, callback: P)

Iterates all known display outputs for the given self and passes a corresponding Output pointer to the given callback for each one, along with the given user_data.

`callback`

A OutputCallback to be called for each display output

`user_data`

A user pointer to be passed to callback

source

pub fn driver(&self) -> Driver

Queries what underlying driver is being used by .

This may only be called on a connected Renderer.

source

pub fn n_fragment_texture_units(&self) -> i32

Queries how many texture units can be used from fragment programs

Returns

the number of texture image units.

source

pub fn winsys_id(&self) -> WinsysID

Queries which window system backend has chosen to use.

This may only be called on a connected Renderer.

Returns

The WinsysID corresponding to the chosen window system backend.

source

pub fn remove_constraint(&self, constraint: RendererConstraint)

This removes a renderer selection constraint.

Applications should ideally minimize how many of these constraints they depend on to ensure maximum portability.

`constraint`

A RendererConstraint to remove

source

pub fn set_driver(&self, driver: Driver)

Requests that should try to use a specific underlying driver for rendering.

If you select an unsupported driver then Renderer::connect will fail and report an error. Most applications should not explicitly select a driver and should rely on automatically choosing the driver.

This may only be called on an un-connected Renderer.

source