Struct BlitRenderPass

pub struct BlitRenderPass(/* private fields */);

Use the Blit Render Pass to blit one or more textures to the screen of the current rendering context using a material. After the blit operation, a Blit Render Pass passes the control to its descendants and then further to its siblings and parent.

Use the Blit Render Pass to show the result of other render passes. For example, to show the result of a Composition Target Render Pass, in the Blit Render Pass bind one of the texture properties (Texture0Property, Texture1Property, Texture2Property, or Texture3Property) to the render target texture that the Composition Target Render Pass creates:

Kanzi Studio uses a default blit material named “DefaultBlitMaterial” which is in the resource dictionary of the Screen node. This default blit material uses only the Texture0Property and its purpose is to show the result of a CompositionTargetRenderPass.

If you use your own materials in a Blit Render Pass, to ensure ease of use in Kanzi Studio projects, use the Blit Render Pass default texture properties.

Implementations

impl BlitRenderPass

pub fn create( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<BlitRenderPass, Error>

Create a Blit Render Pass.

Arguments

• domain - The domain to use.
• name - The name of the Blit Render Pass.

Returns

The created Blit Render Pass.

impl BlitRenderPass

pub fn get_texture0(&self) -> Result<Option<Weak<Resource>>, Error>

See: TEXTURE0_PROPERTY

pub fn set_texture0(&self, value: Option<&Resource>) -> Result<(), Error>

See: TEXTURE0_PROPERTY

pub fn get_texture1(&self) -> Result<Option<Weak<Resource>>, Error>

See: TEXTURE1_PROPERTY

pub fn set_texture1(&self, value: Option<&Resource>) -> Result<(), Error>

See: TEXTURE1_PROPERTY

pub fn get_texture2(&self) -> Result<Option<Weak<Resource>>, Error>

See: TEXTURE2_PROPERTY

pub fn set_texture2(&self, value: Option<&Resource>) -> Result<(), Error>

See: TEXTURE2_PROPERTY

pub fn get_texture3(&self) -> Result<Option<Weak<Resource>>, Error>

See: TEXTURE3_PROPERTY

pub fn set_texture3(&self, value: Option<&Resource>) -> Result<(), Error>

See: TEXTURE3_PROPERTY

pub fn get_texture_cubemap(&self) -> Result<Option<Weak<Resource>>, Error>

See: TEXTURE_CUBEMAP_PROPERTY

pub fn set_texture_cubemap(&self, value: Option<&Resource>) -> Result<(), Error>

See: TEXTURE_CUBEMAP_PROPERTY

pub fn get_material(&self) -> Result<Option<Weak<Resource>>, Error>

See: MATERIAL_PROPERTY

pub fn set_material(&self, value: Option<&Resource>) -> Result<(), Error>

See: MATERIAL_PROPERTY

Methods from Deref<Target = RenderPass>

pub fn get_enabled(&self) -> Result<bool, Error>

See: ENABLED_PROPERTY

pub fn set_enabled(&self, value: bool) -> Result<(), Error>

See: ENABLED_PROPERTY

pub fn get_input_viewport_area(&self) -> Result<Vector4, Error>

See: INPUT_VIEWPORT_AREA_PROPERTY

pub fn set_input_viewport_area(&self, value: Vector4) -> Result<(), Error>

See: INPUT_VIEWPORT_AREA_PROPERTY

pub fn get_update_rate(&self) -> Result<i32, Error>

See: UPDATE_RATE_PROPERTY

pub fn set_update_rate(&self, value: i32) -> Result<(), Error>

See: UPDATE_RATE_PROPERTY

pub fn get_update_offset(&self) -> Result<i32, Error>

See: UPDATE_OFFSET_PROPERTY

pub fn set_update_offset(&self, value: i32) -> Result<(), Error>

See: UPDATE_OFFSET_PROPERTY

Methods from Deref<Target = Resource>

pub fn get_name(&self) -> Result<KanziString, Error>

Gets the resource name.

pub fn get_url(&self) -> Result<KanziString, Error>

Gets the resource URL. Note that the URL is not necessarily in URL form if resource has been just created.

Returns

URL string.

pub fn set_keep_alive(&self, keep_alive: bool) -> Result<(), Error>

Sets the keep alive flag. Can be set only before the resource is registered to the resource manager. Normally set by loadFromKZB.

Arguments

• keep_alive - Value for the keep alive flag.

Methods from Deref<Target = Object>

pub fn as_ptr(&self) -> *mut ObjectWrapper

pub fn as_wrapper(&self) -> &ObjectWrapper

pub fn as_object(&self) -> &Object

Represents any type inheriting from Object as &Object. This is useful for comparisions when PartialEq traits failed to compare objects of different types.

let child = screen.get_child(0)?;
let parent = child.get_parent()?.into_error(ErrorKind::ObjectNotFound)?;
// assert_eq!(screen, parent); // <- Fails to compile!
assert_eq!(screen.as_object(), parent.as_object());

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

Gets a pointer to the backing C++ instance.

pub fn is_stale(&self) -> bool

Checks whether the weak reference has expired.

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers.

Base value is affected by the following inputs where the highest entry in the list determines the base value:

1. Local value set with setProperty or loaded from kzb
2. Value set by a style affecting the property.
3. Value defined by class metadata.

Modifiers are not applied, the highest-priority base value is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

If there is no value sources, None is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the local value of a property type.

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>

where T: PropertyTypeConstraint,

Evaluates whether there are any inputs into the property value. Both value sources and modifiers are taken into account.

Returns

Returns true if there are inputs into the property value, false otherwise.

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Removes the local value associated with the property.

pub fn get_metaclass(&self) -> Result<Metaclass, Error>

Returns the metaclass of the dynamic type of the object.

pub fn get_domain(&self) -> Result<Domain, Error>

Returns the domain the object belongs to.

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the flag to indicate that the property was loaded from KZB.

pub fn debug_string(&self) -> Result<String, Error>

Builds a string representation of the object intended for debugging purposes.

Trait Implementations

impl Clone for BlitRenderPass

fn clone(&self) -> BlitRenderPass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConcreteObjectConstraint for BlitRenderPass

fn create_instance( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<Self, Error>

impl Debug for BlitRenderPass

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

Formats the value using the given formatter.

impl Deref for BlitRenderPass

type Target = RenderPass

The resulting type after dereferencing.

fn deref(&self) -> &<BlitRenderPass as Deref>::Target

Dereferences the value.

impl Inheritable for BlitRenderPass

unsafe fn downcast_unchecked<T>(self) -> T

where T: Inherits<Self>,

Downcast the object to a more specific type.

unsafe fn downcast_unchecked_ref<T>(&self) -> &T

where T: Inherits<Self>,

Downcast the object reference to a more specific type.

impl Inherits<Object> for BlitRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<RenderPass> for BlitRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for BlitRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for BlitRenderPass

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for BlitRenderPass

fn downcast<T>(self) -> Result<Option<T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by value.

fn downcast_ref<T>(&self) -> Result<Option<&T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by reference.

fn is_a<T>(&self) -> Result<bool, Error>

where T: MetaInherits<Self>,

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

fn downgrade(self) -> Weak<Self>

fn downgrade_ref(&self) -> Weak<Self>

fn lock(self) -> ThreadObject<Self>

fn lock_ref(&self) -> ThreadObject<Self>

impl<T> PartialEq<T> for BlitRenderPass

where T: ObjectConstraint,

fn eq(&self, rhs: &T) -> 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<T> PartialEq<Weak<T>> for BlitRenderPass

where T: ObjectConstraint,

fn eq(&self, rhs: &Weak<T>) -> 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 Eq for BlitRenderPass