Struct Surface

pub struct Surface {
    pub bones: InheritableVariable<Vec<Handle<Node>>>,
    /* private fields */
}

Surface is a set of triangles with a single material. Such arrangement makes GPU rendering very efficient.

Surfaces can use the same data source across many instances, this is a memory optimization for being able to re-use data when you need to draw the same mesh in many places. It guarantees, that the data will be in single instance on your GPU.

Examples

use fyrox_resource::untyped::ResourceKind;
fn create_triangle_surface() -> Surface {
    let vertex_buffer = VertexBuffer::new(
        3,
        vec![
            StaticVertex {
                position: Vector3::new(0.0, 0.0, 0.0),
                tex_coord: Vector2::new(0.0, 0.0),
                normal: Vector3::new(0.0, 0.0, 1.0),
                tangent: Vector4::new(1.0, 0.0, 0.0, 1.0),
            },
            StaticVertex {
                position: Vector3::new(0.0, 1.0, 0.0),
                tex_coord: Vector2::new(0.0, 1.0),
                normal: Vector3::new(0.0, 0.0, 1.0),
                tangent: Vector4::new(1.0, 0.0, 0.0, 1.0),
            },
            StaticVertex {
                position: Vector3::new(1.0, 1.0, 0.0),
                tex_coord: Vector2::new(1.0, 1.0),
                normal: Vector3::new(0.0, 0.0, 1.0),
                tangent: Vector4::new(1.0, 0.0, 0.0, 1.0),
            },
        ],
    )
    .unwrap();

    let triangle_buffer = TriangleBuffer::new(vec![TriangleDefinition([0, 1, 2])]);

    let data = SurfaceData::new(vertex_buffer, triangle_buffer);

    SurfaceBuilder::new(SurfaceResource::new_ok(ResourceKind::Embedded, data)).build()
}

This code crates a simple triangle in oXY plane with clockwise winding with normal facing towards the screen. To learn more about vertex and triangle buffers, see VertexBuffer and TriangleBuffer docs respectively.

Usually, there’s no need to create surfaces on per-vertex basis, you can use on of the pre-made methods of SurfaceData to create complex 3D shapes:

use fyrox_resource::untyped::ResourceKind;
fn create_cone_surface() -> Surface {
    SurfaceBuilder::new(SurfaceResource::new_ok(ResourceKind::Embedded, SurfaceData::make_cone(
        16,
        1.0,
        2.0,
        &Matrix4::identity(),
    )))
    .build()
}

This code snippet creates a cone surface instance, check the docs for SurfaceData for more info about built-in methods.

Fields

bones: InheritableVariable<Vec<Handle<Node>>>

Array of handles to scene nodes which are used as bones.

Implementations

impl Surface

pub const DATA: &'static str = "data"

pub const MATERIAL: &'static str = "material"

pub const BONES: &'static str = "bones"

pub const UNIQUE_MATERIAL: &'static str = "unique_material"

impl Surface

pub fn new(data: SurfaceResource) -> Self

Creates new surface instance with given data and without any texture.

pub fn material_id(&self) -> u64

Calculates material id.

pub fn batch_id(&self) -> u64

Calculates batch id.

pub fn data(&self) -> SurfaceResource

Returns current data used by surface.

pub fn data_ref(&self) -> &SurfaceResource

Returns current data used by surface.

pub fn material(&self) -> &MaterialResource

Returns current material of the surface.

pub fn set_material(&mut self, material: MaterialResource)

Sets new material for the surface.

pub fn bones(&self) -> &[Handle<Node>]

Returns list of bones that affects the surface.

pub fn is_unique_material(&self) -> bool

Returns true if the material will be a unique instance when cloning the surface.

pub fn set_unique_material(&mut self, unique: bool)

Defines whether the material will be a unique instance when cloning the surface.

Trait Implementations

impl Clone for Surface

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Surface

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

Formats the value using the given formatter.

impl Default for Surface

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Surface

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Reflect for Surface

where Self: 'static, InheritableVariable<SurfaceResource>: Reflect, InheritableVariable<MaterialResource>: Reflect, InheritableVariable<Vec<Handle<Node>>>: Reflect, InheritableVariable<bool>: 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<Self>) -> 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))

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

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

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

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

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

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

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

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 TypeUuidProvider for Surface

fn type_uuid() -> Uuid

Return type UUID.

impl Visit for Surface

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

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

impl StructuralPartialEq for Surface