template <typename BuilderImpl>

class WireTableBaseBuilder

Defined at line 13278 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/cpp/fidl/fuchsia.sysmem2/cpp/wire_types.h

Public Methods

::fuchsia_sysmem2::wire::FormatCostKey Build ()

Build and return the table. The builder should not be used after this.

bool has_pixel_format ()
void clear_pixel_format ()

Clears the pixel_format field.

This method should be used sparingly, such as only during tests, as it has

O(number_of_fields) complexity.

::fuchsia_images2::wire::PixelFormat & pixel_format ()

The pixel_format and pixel_format_modifier are the format to which this

FormatCost entry applies.

Must be set.

BuilderImpl & pixel_format (::fuchsia_images2::wire::PixelFormat elem)

The pixel_format and pixel_format_modifier are the format to which this

FormatCost entry applies.

Must be set.

bool has_pixel_format_modifier ()
void clear_pixel_format_modifier ()

Clears the pixel_format_modifier field.

This method should be used sparingly, such as only during tests, as it has

O(number_of_fields) complexity.

::fuchsia_images2::wire::PixelFormatModifier & pixel_format_modifier ()

The pixel_format and pixel_format_modifier are the format to which this

FormatCost entry applies.

Un-set is equivalent to LINEAR.

BuilderImpl & pixel_format_modifier (Wrapper_Ignore_Me_< ::fidl::ObjectView< ::fuchsia_images2::wire::PixelFormatModifier>> elem)

The pixel_format and pixel_format_modifier are the format to which this

FormatCost entry applies.

Un-set is equivalent to LINEAR.

bool has_buffer_usage_bits ()
void clear_buffer_usage_bits ()

Clears the buffer_usage_bits field.

This method should be used sparingly, such as only during tests, as it has

O(number_of_fields) complexity.

::fuchsia_sysmem2::wire::BufferUsage & buffer_usage_bits ()

If set, this entry is only considered if the buffer collection has at

least these usage bits set.

The buffer collection has an aggregated BufferUsage which is the union

of per-participant BufferUsage bits. FormatCost entries with additional

set bits are ignored. Among the rest, the one with matching format and

the most usage bits set determines the cost of that format for that

buffer collection.

Then the lowest-cost format is chosen for that buffer collection among

the formats that are mutually suppored by all the participants of that

buffer collection.

The main intent of this field is to allow "waving off" a format that

works, but doesn't perform well, for a particular combination of usages.

In that case the cost can be set high when the problematic combination

of usage bits is set. The format will still be chosen if this format is

the only mutually-supported format among the participants of the buffer

collection.

Un-set is equivalent to zero usage bits set, meaning the entry applies

to the format unless another entry with more specific usage applies.

It can be reasonable in some cases for all entries to omit this field,

when/if format selection based on format cost alone, ignoring usage, is

sufficient.

BuilderImpl & buffer_usage_bits (Wrapper_Ignore_Me_< ::fidl::ObjectView< ::fuchsia_sysmem2::wire::BufferUsage>> elem)

If set, this entry is only considered if the buffer collection has at

least these usage bits set.

The buffer collection has an aggregated BufferUsage which is the union

of per-participant BufferUsage bits. FormatCost entries with additional

set bits are ignored. Among the rest, the one with matching format and

the most usage bits set determines the cost of that format for that

buffer collection.

Then the lowest-cost format is chosen for that buffer collection among

the formats that are mutually suppored by all the participants of that

buffer collection.

The main intent of this field is to allow "waving off" a format that

works, but doesn't perform well, for a particular combination of usages.

In that case the cost can be set high when the problematic combination

of usage bits is set. The format will still be chosen if this format is

the only mutually-supported format among the participants of the buffer

collection.

Un-set is equivalent to zero usage bits set, meaning the entry applies

to the format unless another entry with more specific usage applies.

It can be reasonable in some cases for all entries to omit this field,

when/if format selection based on format cost alone, ignoring usage, is

sufficient.

Protected Methods

void WireTableBaseBuilder< ::fuchsia_sysmem2::wire::FormatCostKey, BuilderImpl> (::fidl::ObjectView< ::fidl::WireTableFrame< ::fuchsia_sysmem2::wire::FormatCostKey>> && frame)

Records