Struct zng_view_api::window::FrameUpdateRequest

pub struct FrameUpdateRequest {
    pub id: FrameId,
    pub transforms: Vec<FrameValueUpdate<PxTransform>>,
    pub floats: Vec<FrameValueUpdate<f32>>,
    pub colors: Vec<FrameValueUpdate<Rgba>>,
    pub extensions: Vec<(ApiExtensionId, ApiExtensionPayload)>,
    pub clear_color: Option<Rgba>,
    pub capture: FrameCapture,
    pub wait_id: Option<FrameWaitId>,
}

Data for rendering a new frame that is derived from the current frame.

Fields

id: FrameId

ID of the new frame.

transforms: Vec<FrameValueUpdate<PxTransform>>

Bound transforms.

floats: Vec<FrameValueUpdate<f32>>

Bound floats.

colors: Vec<FrameValueUpdate<Rgba>>

Bound colors.

extensions: Vec<(ApiExtensionId, ApiExtensionPayload)>

Update payload for API extensions.

The zng-view crate implements this by calling DisplayListExtension::update with the payload.

clear_color: Option<Rgba>

New clear color.

capture: FrameCapture

Create an image or mask from this rendered frame.

The Event::FrameImageReady is send with the image.

wait_id: Option<FrameWaitId>

Identifies this frame as the response to the WindowChanged resized frame request.

Implementations

impl FrameUpdateRequest

pub fn empty(id: FrameId) -> FrameUpdateRequest

A request that does nothing, apart from re-rendering the frame.

pub fn has_bounds(&self) -> bool

If some property updates are requested.

pub fn is_empty(&self) -> bool

If this request does not do anything, apart from notifying a new frame if send to the renderer.

Trait Implementations

impl Clone for FrameUpdateRequest

fn clone(&self) -> FrameUpdateRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameUpdateRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrameUpdateRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FrameUpdateRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.