|
virtual | ~BlitPass () |
|
virtual bool | IsValid () const =0 |
|
void | SetLabel (std::string_view label) |
|
virtual bool | ConvertTextureToShaderRead (const std::shared_ptr< Texture > &texture) |
| If the texture is not already in a shader read internal state, then convert it to that state. More...
|
|
virtual bool | ResizeTexture (const std::shared_ptr< Texture > &source, const std::shared_ptr< Texture > &destination)=0 |
| Resize the [source] texture into the [destination] texture. More...
|
|
bool | AddCopy (std::shared_ptr< Texture > source, std::shared_ptr< Texture > destination, std::optional< IRect > source_region=std::nullopt, IPoint destination_origin={}, std::string_view label="") |
| Record a command to copy the contents of one texture to another texture. The blit area is limited by the intersection of the texture coverage with respect the source region and destination origin. More...
|
|
bool | AddCopy (std::shared_ptr< Texture > source, std::shared_ptr< DeviceBuffer > destination, std::optional< IRect > source_region=std::nullopt, size_t destination_offset=0, std::string_view label="") |
| Record a command to copy the contents of a texture to a buffer. More...
|
|
bool | AddCopy (BufferView source, std::shared_ptr< Texture > destination, std::optional< IRect > destination_region=std::nullopt, std::string_view label="", uint32_t mip_level=0, uint32_t slice=0, bool convert_to_read=true) |
| Record a command to copy the contents of a buffer to a texture. More...
|
|
bool | GenerateMipmap (std::shared_ptr< Texture > texture, std::string_view label="") |
| Record a command to generate all mip levels for a texture. More...
|
|
virtual bool | EncodeCommands () const =0 |
| Encode the recorded commands to the underlying command buffer. More...
|
|
|
| BlitPass () |
|
virtual void | OnSetLabel (std::string_view label)=0 |
|
virtual bool | OnCopyTextureToTextureCommand (std::shared_ptr< Texture > source, std::shared_ptr< Texture > destination, IRect source_region, IPoint destination_origin, std::string_view label)=0 |
|
virtual bool | OnCopyTextureToBufferCommand (std::shared_ptr< Texture > source, std::shared_ptr< DeviceBuffer > destination, IRect source_region, size_t destination_offset, std::string_view label)=0 |
|
virtual bool | OnCopyBufferToTextureCommand (BufferView source, std::shared_ptr< Texture > destination, IRect destination_region, std::string_view label, uint32_t mip_level, uint32_t slice, bool convert_to_read)=0 |
|
virtual bool | OnGenerateMipmapCommand (std::shared_ptr< Texture > texture, std::string_view label)=0 |
|
Blit passes encode blit into the underlying command buffer.
Blit passes can be obtained from the command buffer in which
the pass is meant to encode commands into.
- See also
CommandBuffer
Definition at line 27 of file blit_pass.h.
bool impeller::BlitPass::AddCopy |
( |
BufferView |
source, |
|
|
std::shared_ptr< Texture > |
destination, |
|
|
std::optional< IRect > |
destination_region = std::nullopt , |
|
|
std::string_view |
label = "" , |
|
|
uint32_t |
mip_level = 0 , |
|
|
uint32_t |
slice = 0 , |
|
|
bool |
convert_to_read = true |
|
) |
| |
Record a command to copy the contents of a buffer to a texture.
- Parameters
-
[in] | source | The buffer view to read for copying. |
[in] | destination | The texture to overwrite using the source contents. |
[in] | destination_region | The offset to start writing to in the destination texture. If not provided, this defaults to the entire texture. |
[in] | label | The optional debug label to give the command. |
[in] | mip_level | The mip level to write to. |
[in] | slice | For cubemap textures, the slice to write data to. |
[in] | convert_to_read | Whether to convert the texture to a shader read state. Defaults to true. |
- Returns
- If the command was valid for subsequent commitment.
If a region smaller than the texture size is provided, the contents are treated as containing tightly packed pixel data of that region. Only the portion of the texture in this region is replaced and existing data is preserved.
For example, to replace the top left 10 x 10 region of a larger 100 x 100 texture, the region is {0, 0, 10, 10} and the expected buffer size in bytes is 100 x bpp.
Definition at line 116 of file blit_pass.cc.
124 VALIDATION_LOG <<
"Attempted to add a texture blit with no destination.";
127 ISize destination_size = destination->GetSize();
128 IRect destination_region_value =
130 if (destination_region_value.GetX() < 0 ||
131 destination_region_value.GetY() < 0 ||
132 destination_region_value.GetRight() > destination_size.width ||
133 destination_region_value.GetBottom() > destination_size.height) {
134 VALIDATION_LOG <<
"Blit region cannot be larger than destination texture.";
138 auto bytes_per_pixel =
140 auto bytes_per_region = destination_region_value.Area() * bytes_per_pixel;
142 if (source.GetRange().length != bytes_per_region) {
144 <<
"Attempted to add a texture blit with out of bounds access.";
147 if (mip_level >= destination->GetMipCount()) {
148 VALIDATION_LOG <<
"Invalid value for mip_level: " << mip_level <<
". "
149 <<
"The destination texture has "
150 << destination->GetMipCount() <<
" mip levels.";
159 destination_region_value, label,
160 mip_level, slice, convert_to_read);
virtual bool OnCopyBufferToTextureCommand(BufferView source, std::shared_ptr< Texture > destination, IRect destination_region, std::string_view label, uint32_t mip_level, uint32_t slice, bool convert_to_read)=0
constexpr size_t BytesPerPixelForPixelFormat(PixelFormat format)
constexpr static TRect MakeSize(const TSize< U > &size)
References impeller::TRect< T >::Area(), impeller::BytesPerPixelForPixelFormat(), impeller::TRect< T >::GetBottom(), impeller::BufferView::GetRange(), impeller::TRect< T >::GetRight(), impeller::TRect< T >::GetX(), impeller::TRect< T >::GetY(), impeller::TSize< T >::height, impeller::Range::length, impeller::TRect< T >::MakeSize(), OnCopyBufferToTextureCommand(), VALIDATION_LOG, and impeller::TSize< T >::width.
bool impeller::BlitPass::AddCopy |
( |
std::shared_ptr< Texture > |
source, |
|
|
std::shared_ptr< Texture > |
destination, |
|
|
std::optional< IRect > |
source_region = std::nullopt , |
|
|
IPoint |
destination_origin = {} , |
|
|
std::string_view |
label = "" |
|
) |
| |
Record a command to copy the contents of one texture to another texture. The blit area is limited by the intersection of the texture coverage with respect the source region and destination origin.
- Parameters
-
[in] | source | The texture to read for copying. |
[in] | destination | The texture to overwrite using the source contents. |
[in] | source_region | The optional region of the source texture to use for copying. If not specified, the full size of the source texture is used. |
[in] | destination_origin | The origin to start writing to in the destination texture. |
[in] | label | The optional debug label to give the command. |
- Returns
- If the command was valid for subsequent commitment.
Definition at line 26 of file blit_pass.cc.
32 VALIDATION_LOG <<
"Attempted to add a texture blit with no source.";
36 VALIDATION_LOG <<
"Attempted to add a texture blit with no destination.";
40 if (source->GetTextureDescriptor().sample_count !=
41 destination->GetTextureDescriptor().sample_count) {
43 "The source sample count (%d) must match the destination sample count "
45 static_cast<int>(source->GetTextureDescriptor().sample_count),
46 static_cast<int>(destination->GetTextureDescriptor().sample_count));
49 if (source->GetTextureDescriptor().format !=
50 destination->GetTextureDescriptor().format) {
52 "The source pixel format (%s) must match the destination pixel format "
60 if (!source_region.has_value()) {
67 if (!source_region.has_value()) {
72 std::move(source), std::move(destination), source_region.value(),
73 destination_origin, label);
virtual bool OnCopyTextureToTextureCommand(std::shared_ptr< Texture > source, std::shared_ptr< Texture > destination, IRect source_region, IPoint destination_origin, std::string_view label)=0
std::string SPrintF(const char *format,...)
constexpr const char * PixelFormatToString(PixelFormat format)
References impeller::TRect< T >::MakeSize(), OnCopyTextureToTextureCommand(), impeller::PixelFormatToString(), impeller::SPrintF(), and VALIDATION_LOG.