Struct fyrox::scene::SceneRenderingOptions

pub struct SceneRenderingOptions {
    pub render_target: Option<Resource<Texture>>,
    pub clear_color: Option<Color>,
    pub polygon_rasterization_mode: PolygonFillMode,
    pub ambient_lighting_color: Color,
}

Rendering options of a scene. It allows you to specify a render target to render the scene to, change its clear color, etc.

Fields

render_target: Option<Resource<Texture>>

A texture to draw the scene to. If empty, then the scene will be drawn on screen directly. It is useful to “embed” some scene into other by drawing a quad with this texture. This can be used to make in-game video conference - you can make separate scene with your characters and draw scene into a texture, then in the main scene you can attach this texture to some quad which will be used as a monitor. Other usage could be a previewer of models, like a pictogram of character in real-time strategies, in other words there are plenty of possible uses.

clear_color: Option<Color>

Default color of the render target. Default is None, which forces the renderer to use clear color of the back buffer. Could be set to transparent to make background transparent.

polygon_rasterization_mode: PolygonFillMode

Defines how polygons of the scene will be rasterized. By default it set to PolygonFillMode::Fill, PolygonFillMode::Line could be used to render the scene in wireframe mode.

ambient_lighting_color: Color

Color of the ambient lighting.

Implementations

impl SceneRenderingOptions

pub const RENDER_TARGET: &'static str = "render_target"

pub const CLEAR_COLOR: &'static str = "clear_color"

pub const POLYGON_RASTERIZATION_MODE: &'static str = "polygon_rasterization_mode"

pub const AMBIENT_LIGHTING_COLOR: &'static str = "ambient_lighting_color"

Trait Implementations

impl Clone for SceneRenderingOptions

fn clone(&self) -> SceneRenderingOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SceneRenderingOptions

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

Formats the value using the given formatter.

impl Default for SceneRenderingOptions

fn default() -> SceneRenderingOptions

Returns the “default value” for a type.

impl PartialEq for SceneRenderingOptions

fn eq(&self, other: &SceneRenderingOptions) -> 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 Reflect for SceneRenderingOptions

where SceneRenderingOptions: 'static, Option<Resource<Texture>>: Reflect, Option<Color>: Reflect, PolygonFillMode: Reflect, Color: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<SceneRenderingOptions>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect> ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&(dyn Any + 'static)))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Any + 'static)))

fn as_reflect(&self, func: &mut dyn FnMut(&(dyn Reflect + 'static)))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Reflect + 'static)))

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]) )

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>) )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>) )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>) )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>) )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>) )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>) )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>) )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>) )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>) )

impl Visit for SceneRenderingOptions

where Option<Resource<Texture>>: Visit, Option<Color>: Visit, PolygonFillMode: Visit, Color: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl StructuralPartialEq for SceneRenderingOptions