Struct fidl_fuchsia_ui_composition::RegisterBufferCollectionArgs

pub struct RegisterBufferCollectionArgs {
    pub export_token: Option<BufferCollectionExportToken>,
    pub buffer_collection_token: Option<ClientEnd<BufferCollectionTokenMarker>>,
    pub usage: Option<RegisterBufferCollectionUsage>,
    pub usages: Option<RegisterBufferCollectionUsages>,
    /* private fields */
}

The table of arguments for [RegisterBufferCollection]. Note that some fields below are REQUIRED.

Fields

export_token: Option<BufferCollectionExportToken>

Clients can send [export_token] to register buffer collections with Allocator to be used later in [fuchsia.ui.composition/Flatland] instances or other Scenic APIs, such as Screenshot.

For example, by passing a BufferCollectionImportToken containing the matching peer of BufferCollectionExportToken, they can create image resources via [fuchsia.ui.composition/Flatland.CreateImage].

Clients should wait for the response before using import_token.

This field is REQUIRED.

buffer_collection_token: Option<ClientEnd<BufferCollectionTokenMarker>>

Flatland participates in the allocation of buffers by setting constraints on the BufferCollection referenced by buffer_collection_token. It will not block on buffers being allocated until the client creates content using the BufferCollection.

The buffer collection registered with export_token is available and kept alive as long as the client holds a valid BufferCollectionImportToken. They will be garbage collected when all BufferCollectionImportTokens are closed and all the associated Image resources are released.

This field is REQUIRED.

usage: Option<RegisterBufferCollectionUsage>

The client can register a buffer collection for various uses, each coming with their own unique constraints.

This field is OPTIONAL. If usage is omitted it will be treated as if it has the DEFAULT option.

Deprecation

This arg is deprecated at API version 9 with addition of |usages|.

If both the usages and usage fields are set, usages takes precedence and usage is ignored.

usages: Option<RegisterBufferCollectionUsages>

The client can register a buffer collection for various uses and has the ability to combine usages if multiple are needed.

This field is OPTIONAL. If usages is omitted it will be treated as if it has only the DEFAULT option.

Trait Implementations

impl Debug for RegisterBufferCollectionArgs

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

Formats the value using the given formatter.

impl Decode<RegisterBufferCollectionArgs> for RegisterBufferCollectionArgs

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_>, offset: usize, depth: Depth ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for RegisterBufferCollectionArgs

fn default() -> RegisterBufferCollectionArgs

Returns the “default value” for a type.

impl Encode<RegisterBufferCollectionArgs> for &mut RegisterBufferCollectionArgs

unsafe fn encode( self, encoder: &mut Encoder<'_>, offset: usize, depth: Depth ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for RegisterBufferCollectionArgs

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

type Borrowed<'a> = &'a mut RegisterBufferCollectionArgs

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &mut Self::Owned. There are three cases:

fn take_or_borrow<'a>( value: &'a mut <Self as TypeMarker>::Owned ) -> Self::Borrowed<'a>

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for RegisterBufferCollectionArgs

type Owned = RegisterBufferCollectionArgs

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl Standalone for RegisterBufferCollectionArgs

impl StructuralPartialEq for RegisterBufferCollectionArgs