Flutter Engine
The Flutter Engine
Public Member Functions | Friends | List of all members
impeller::StandardCapabilities Class Referencefinal
Inheritance diagram for impeller::StandardCapabilities:
impeller::Capabilities

Public Member Functions

 ~StandardCapabilities () override=default
 
bool SupportsOffscreenMSAA () const override
 Whether the context backend supports attaching offscreen MSAA color/stencil textures. More...
 
bool SupportsImplicitResolvingMSAA () const override
 Whether the context backend supports multisampled rendering to the on-screen surface without requiring an explicit resolve of the MSAA color attachment. More...
 
bool SupportsSSBO () const override
 Whether the context backend supports binding Shader Storage Buffer Objects (SSBOs) to pipelines. More...
 
bool SupportsTextureToTextureBlits () const override
 Whether the context backend supports blitting from one texture region to another texture region (via the relevant BlitPass::AddCopy overloads). More...
 
bool SupportsFramebufferFetch () const override
 Whether the context backend is able to support pipelines with shaders that read from the framebuffer (i.e. pixels that have been written by previous draw calls in the current render pass). More...
 
bool SupportsCompute () const override
 Whether the context backend supports ComputePass. More...
 
bool SupportsComputeSubgroups () const override
 Whether the context backend supports configuring ComputePass command subgroups. More...
 
bool SupportsReadFromResolve () const override
 Whether the context backend supports binding the current RenderPass attachments. This is supported if the backend can guarantee that attachment textures will not be mutated until the render pass has fully completed. More...
 
bool SupportsDecalSamplerAddressMode () const override
 Whether the context backend supports SamplerAddressMode::Decal. More...
 
PixelFormat GetDefaultColorFormat () const override
 Returns a supported PixelFormat for textures that store 4-channel colors (red/green/blue/alpha). More...
 
PixelFormat GetDefaultStencilFormat () const override
 Returns a supported PixelFormat for textures that store stencil information. May include a depth channel if a stencil-only format is not available. More...
 
PixelFormat GetDefaultDepthStencilFormat () const override
 Returns a supported PixelFormat for textures that store both a stencil and depth component. This will never return a depth-only or stencil-only texture. Returns PixelFormat::kUnknown if no suitable depth+stencil format was found. More...
 
bool SupportsDeviceTransientTextures () const override
 Whether the context backend supports allocating StorageMode::kDeviceTransient (aka "memoryless") textures, which are temporary textures kept in tile memory for the duration of the RenderPass it's attached to. More...
 
PixelFormat GetDefaultGlyphAtlasFormat () const override
 Returns the default pixel format for the alpha bitmap glyph atlas. More...
 
- Public Member Functions inherited from impeller::Capabilities
virtual ~Capabilities ()
 
virtual bool SupportsOffscreenMSAA () const =0
 Whether the context backend supports attaching offscreen MSAA color/stencil textures. More...
 
virtual bool SupportsImplicitResolvingMSAA () const =0
 Whether the context backend supports multisampled rendering to the on-screen surface without requiring an explicit resolve of the MSAA color attachment. More...
 
virtual bool SupportsSSBO () const =0
 Whether the context backend supports binding Shader Storage Buffer Objects (SSBOs) to pipelines. More...
 
virtual bool SupportsTextureToTextureBlits () const =0
 Whether the context backend supports blitting from one texture region to another texture region (via the relevant BlitPass::AddCopy overloads). More...
 
virtual bool SupportsFramebufferFetch () const =0
 Whether the context backend is able to support pipelines with shaders that read from the framebuffer (i.e. pixels that have been written by previous draw calls in the current render pass). More...
 
virtual bool SupportsCompute () const =0
 Whether the context backend supports ComputePass. More...
 
virtual bool SupportsComputeSubgroups () const =0
 Whether the context backend supports configuring ComputePass command subgroups. More...
 
virtual bool SupportsReadFromResolve () const =0
 Whether the context backend supports binding the current RenderPass attachments. This is supported if the backend can guarantee that attachment textures will not be mutated until the render pass has fully completed. More...
 
virtual bool SupportsDecalSamplerAddressMode () const =0
 Whether the context backend supports SamplerAddressMode::Decal. More...
 
virtual bool SupportsDeviceTransientTextures () const =0
 Whether the context backend supports allocating StorageMode::kDeviceTransient (aka "memoryless") textures, which are temporary textures kept in tile memory for the duration of the RenderPass it's attached to. More...
 
virtual PixelFormat GetDefaultColorFormat () const =0
 Returns a supported PixelFormat for textures that store 4-channel colors (red/green/blue/alpha). More...
 
virtual PixelFormat GetDefaultStencilFormat () const =0
 Returns a supported PixelFormat for textures that store stencil information. May include a depth channel if a stencil-only format is not available. More...
 
virtual PixelFormat GetDefaultDepthStencilFormat () const =0
 Returns a supported PixelFormat for textures that store both a stencil and depth component. This will never return a depth-only or stencil-only texture. Returns PixelFormat::kUnknown if no suitable depth+stencil format was found. More...
 
virtual PixelFormat GetDefaultGlyphAtlasFormat () const =0
 Returns the default pixel format for the alpha bitmap glyph atlas. More...
 

Friends

class CapabilitiesBuilder
 

Additional Inherited Members

- Protected Member Functions inherited from impeller::Capabilities
 Capabilities ()
 
 Capabilities (const Capabilities &)=delete
 
Capabilitiesoperator= (const Capabilities &)=delete
 

Detailed Description

Definition at line 14 of file capabilities.cc.

Constructor & Destructor Documentation

◆ ~StandardCapabilities()

impeller::StandardCapabilities::~StandardCapabilities ( )
overridedefault

Member Function Documentation

◆ GetDefaultColorFormat()

PixelFormat impeller::StandardCapabilities::GetDefaultColorFormat ( ) const
inlineoverridevirtual

Returns a supported PixelFormat for textures that store 4-channel colors (red/green/blue/alpha).

Implements impeller::Capabilities.

Definition at line 59 of file capabilities.cc.

59 {
60 return default_color_format_;
61 }

◆ GetDefaultDepthStencilFormat()

PixelFormat impeller::StandardCapabilities::GetDefaultDepthStencilFormat ( ) const
inlineoverridevirtual

Returns a supported PixelFormat for textures that store both a stencil and depth component. This will never return a depth-only or stencil-only texture. Returns PixelFormat::kUnknown if no suitable depth+stencil format was found.

Implements impeller::Capabilities.

Definition at line 69 of file capabilities.cc.

69 {
70 return default_depth_stencil_format_;
71 }

◆ GetDefaultGlyphAtlasFormat()

PixelFormat impeller::StandardCapabilities::GetDefaultGlyphAtlasFormat ( ) const
inlineoverridevirtual

Returns the default pixel format for the alpha bitmap glyph atlas.

   Some backends may use Red channel while others use grey. This
   should not have any impact 

Implements impeller::Capabilities.

Definition at line 79 of file capabilities.cc.

79 {
80 return default_glyph_atlas_format_;
81 }

◆ GetDefaultStencilFormat()

PixelFormat impeller::StandardCapabilities::GetDefaultStencilFormat ( ) const
inlineoverridevirtual

Returns a supported PixelFormat for textures that store stencil information. May include a depth channel if a stencil-only format is not available.

Implements impeller::Capabilities.

Definition at line 64 of file capabilities.cc.

64 {
65 return default_stencil_format_;
66 }

◆ SupportsCompute()

bool impeller::StandardCapabilities::SupportsCompute ( ) const
inlineoverridevirtual

Whether the context backend supports ComputePass.

Implements impeller::Capabilities.

Definition at line 41 of file capabilities.cc.

41{ return supports_compute_; }

◆ SupportsComputeSubgroups()

bool impeller::StandardCapabilities::SupportsComputeSubgroups ( ) const
inlineoverridevirtual

Whether the context backend supports configuring ComputePass command subgroups.

Implements impeller::Capabilities.

Definition at line 44 of file capabilities.cc.

44 {
45 return supports_compute_subgroups_;
46 }

◆ SupportsDecalSamplerAddressMode()

bool impeller::StandardCapabilities::SupportsDecalSamplerAddressMode ( ) const
inlineoverridevirtual

Whether the context backend supports SamplerAddressMode::Decal.

Implements impeller::Capabilities.

Definition at line 54 of file capabilities.cc.

54 {
55 return supports_decal_sampler_address_mode_;
56 }

◆ SupportsDeviceTransientTextures()

bool impeller::StandardCapabilities::SupportsDeviceTransientTextures ( ) const
inlineoverridevirtual

Whether the context backend supports allocating StorageMode::kDeviceTransient (aka "memoryless") textures, which are temporary textures kept in tile memory for the duration of the RenderPass it's attached to.

This feature is especially useful for MSAA and stencils.

Implements impeller::Capabilities.

Definition at line 74 of file capabilities.cc.

74 {
75 return supports_device_transient_textures_;
76 }

◆ SupportsFramebufferFetch()

bool impeller::StandardCapabilities::SupportsFramebufferFetch ( ) const
inlineoverridevirtual

Whether the context backend is able to support pipelines with shaders that read from the framebuffer (i.e. pixels that have been written by previous draw calls in the current render pass).

Example of reading from the first color attachment in a GLSL shader: ``` uniform subpassInput subpass_input;

out vec4 frag_color;

void main() { vec4 color = subpassLoad(subpass_input); // Invert the colors drawn to the framebuffer. frag_color = vec4(vec3(1) - color.rgb, color.a); } ```

Implements impeller::Capabilities.

Definition at line 36 of file capabilities.cc.

36 {
37 return supports_framebuffer_fetch_;
38 }

◆ SupportsImplicitResolvingMSAA()

bool impeller::StandardCapabilities::SupportsImplicitResolvingMSAA ( ) const
inlineoverridevirtual

Whether the context backend supports multisampled rendering to the on-screen surface without requiring an explicit resolve of the MSAA color attachment.

Implements impeller::Capabilities.

Definition at line 25 of file capabilities.cc.

25{ return false; }

◆ SupportsOffscreenMSAA()

bool impeller::StandardCapabilities::SupportsOffscreenMSAA ( ) const
inlineoverridevirtual

Whether the context backend supports attaching offscreen MSAA color/stencil textures.

Implements impeller::Capabilities.

Definition at line 20 of file capabilities.cc.

20 {
21 return supports_offscreen_msaa_;
22 }

◆ SupportsReadFromResolve()

bool impeller::StandardCapabilities::SupportsReadFromResolve ( ) const
inlineoverridevirtual

Whether the context backend supports binding the current RenderPass attachments. This is supported if the backend can guarantee that attachment textures will not be mutated until the render pass has fully completed.

This is possible because many mobile graphics cards track RenderPass attachment state in intermediary tile memory prior to Storing the pass in the heap allocated attachments on DRAM. Metal's hazard tracking and Vulkan's barriers are granular enough to allow for safely accessing attachment textures prior to storage in the same RenderPass.

Implements impeller::Capabilities.

Definition at line 49 of file capabilities.cc.

49 {
50 return supports_read_from_resolve_;
51 }

◆ SupportsSSBO()

bool impeller::StandardCapabilities::SupportsSSBO ( ) const
inlineoverridevirtual

Whether the context backend supports binding Shader Storage Buffer Objects (SSBOs) to pipelines.

Implements impeller::Capabilities.

Definition at line 28 of file capabilities.cc.

28{ return supports_ssbo_; }

◆ SupportsTextureToTextureBlits()

bool impeller::StandardCapabilities::SupportsTextureToTextureBlits ( ) const
inlineoverridevirtual

Whether the context backend supports blitting from one texture region to another texture region (via the relevant BlitPass::AddCopy overloads).

Implements impeller::Capabilities.

Definition at line 31 of file capabilities.cc.

31 {
32 return supports_texture_to_texture_blits_;
33 }

Friends And Related Function Documentation

◆ CapabilitiesBuilder

friend class CapabilitiesBuilder
friend

Definition at line 112 of file capabilities.cc.


The documentation for this class was generated from the following file: