impeller::testing::MetalScreenshot Class Reference

A screenshot that was produced from MetalScreenshotter. More...

#include <metal_screenshot.h>

Inheritance diagram for impeller::testing::MetalScreenshot:

Public Member Functions
	MetalScreenshot (CGImageRef cgImage)
	~MetalScreenshot ()
const uint8_t *	GetBytes () const override
	Access raw data of the screenshot.
size_t	GetHeight () const override
	Returns the height of the image in pixels.
size_t	GetWidth () const override
	Returns the width of the image in pixels.
size_t	GetBytesPerRow () const override
	Returns number of bytes required to represent one row of the raw image.
bool	WriteToPNG (const std::string &path) const override
Public Member Functions inherited from impeller::testing::Screenshot
virtual	~Screenshot ()=default

Detailed Description

A screenshot that was produced from MetalScreenshotter.

Definition at line 20 of file metal_screenshot.h.

Constructor & Destructor Documentation

MetalScreenshot()

impeller::testing::MetalScreenshot::MetalScreenshot ( CGImageRef  cgImage )

explicit

Definition at line 10 of file metal_screenshot.mm.

                                                   : cg_image_(cgImage) {
  CGDataProviderRef data_provider = CGImageGetDataProvider(cgImage);
  pixel_data_ = CGDataProviderCopyData(data_provider);
}

~MetalScreenshot()

impeller::testing::MetalScreenshot::~MetalScreenshot

(

)

Definition at line 15 of file metal_screenshot.mm.

                                  {
  CFRelease(pixel_data_);
  CGImageRelease(cg_image_);
}

Member Function Documentation

GetBytes()

const uint8_t * impeller::testing::MetalScreenshot::GetBytes ( ) const

overridevirtual

Access raw data of the screenshot.

Implements impeller::testing::Screenshot.

Definition at line 20 of file metal_screenshot.mm.

                                               {
  return CFDataGetBytePtr(pixel_data_);
}

GetBytesPerRow()

size_t impeller::testing::MetalScreenshot::GetBytesPerRow ( ) const

overridevirtual

Returns number of bytes required to represent one row of the raw image.

Implements impeller::testing::Screenshot.

Definition at line 32 of file metal_screenshot.mm.

                                             {
  return CGImageGetBytesPerRow(cg_image_);
}

GetHeight()

size_t impeller::testing::MetalScreenshot::GetHeight ( ) const

overridevirtual

Returns the height of the image in pixels.

Implements impeller::testing::Screenshot.

Definition at line 24 of file metal_screenshot.mm.

                                        {
  return CGImageGetHeight(cg_image_);
}

GetWidth()

size_t impeller::testing::MetalScreenshot::GetWidth ( ) const

overridevirtual

Returns the width of the image in pixels.

Implements impeller::testing::Screenshot.

Definition at line 28 of file metal_screenshot.mm.

                                       {
  return CGImageGetWidth(cg_image_);
}

WriteToPNG()

bool impeller::testing::MetalScreenshot::WriteToPNG ( const std::string &  path ) const

overridevirtual

Synchronously write the screenshot to disk as a PNG at path. Returns true if it succeeded.

Implements impeller::testing::Screenshot.

Definition at line 36 of file metal_screenshot.mm.

                                                            {
  bool result = false;
  NSURL* output_url =
      [NSURL fileURLWithPath:[NSString stringWithUTF8String:path.c_str()]];
  CGImageDestinationRef destination = CGImageDestinationCreateWithURL(
      (__bridge CFURLRef)output_url, kUTTypePNG, 1, nullptr);
  if (destination != nullptr) {
    CGImageDestinationAddImage(destination, cg_image_,
                               (__bridge CFDictionaryRef) @{});
 
    if (CGImageDestinationFinalize(destination)) {
      result = true;
    }
 
    CFRelease(destination);
  }
  return result;
}

---

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

• impeller/golden_tests/metal_screenshot.h
• impeller/golden_tests/metal_screenshot.mm