flutter::testing::TestMetalContext Class Reference

#include <test_metal_context.h>

Classes
struct	TextureInfo

Public Member Functions
	TestMetalContext ()
	~TestMetalContext ()
id< MTLDevice >	GetMetalDevice () const
id< MTLCommandQueue >	GetMetalCommandQueue () const
sk_sp< GrDirectContext >	GetSkiaContext () const
TextureInfo	CreateMetalTexture (const DlISize &size)
	Returns texture_id = -1 when texture creation fails.
bool	Present (int64_t texture_id)
TextureInfo	GetTextureInfo (int64_t texture_id)

Detailed Description

Definition at line 22 of file test_metal_context.h.

Constructor & Destructor Documentation

TestMetalContext()

flutter::testing::TestMetalContext::TestMetalContext

(

)

Definition at line 19 of file test_metal_context.mm.

                                   {
  id<MTLDevice> device = MTLCreateSystemDefaultDevice();
  if (!device) {
    FML_LOG(ERROR) << "Could not acquire Metal device.";
    return;
  }
 
  id<MTLCommandQueue> command_queue = [device newCommandQueue];
  if (!command_queue) {
    FML_LOG(ERROR) << "Could not create the default command queue.";
    return;
  }
 
  [command_queue setLabel:@"Flutter Test Queue"];
 
  GrMtlBackendContext backendContext = {};
  // Skia expect arguments to `MakeMetal` transfer ownership of the reference in for release later
  // when the GrDirectContext is collected.
  backendContext.fDevice.retain((__bridge GrMTLHandle)device);
  backendContext.fQueue.retain((__bridge GrMTLHandle)command_queue);
  skia_context_ = GrDirectContexts::MakeMetal(backendContext);
  if (!skia_context_) {
    FML_LOG(ERROR) << "Could not create the GrDirectContext from the Metal Device "
                      "and command queue.";
  }
  device_ = device;
  command_queue_ = command_queue;
}

References device, and FML_LOG.

~TestMetalContext()

flutter::testing::TestMetalContext::~TestMetalContext

(

)

Definition at line 48 of file test_metal_context.mm.

                                    {
  std::scoped_lock lock(textures_mutex_);
  textures_.clear();
}

Member Function Documentation

CreateMetalTexture()

TestMetalContext::TextureInfo flutter::testing::TestMetalContext::CreateMetalTexture

(

const DlISize &

size

)

Returns texture_id = -1 when texture creation fails.

Definition at line 65 of file test_metal_context.mm.

                                                                                    {
  std::scoped_lock lock(textures_mutex_);
  MTLTextureDescriptor* texture_descriptor =
      [MTLTextureDescriptor texture2DDescriptorWithPixelFormat:MTLPixelFormatBGRA8Unorm
                                                         width:size.width
                                                        height:size.height
                                                     mipmapped:NO];
 
  // The most pessimistic option and disables all optimizations but allows tests
  // the most flexible access to the surface. They may read and write to the
  // surface from shaders or use as a pixel view.
  texture_descriptor.usage = MTLTextureUsageUnknown;
 
  if (!texture_descriptor) {
    FML_CHECK(false) << "Invalid texture descriptor.";
    return {.texture_id = -1, .texture = nullptr};
  }
 
  if (!device_) {
    FML_CHECK(false) << "Invalid Metal device.";
    return {.texture_id = -1, .texture = nullptr};
  }
 
  id<MTLTexture> texture = [device_ newTextureWithDescriptor:texture_descriptor];
  if (!texture) {
    FML_CHECK(false) << "Could not create texture from texture descriptor.";
    return {.texture_id = -1, .texture = nullptr};
  }
 
  const int64_t texture_id = texture_id_ctr_++;
  sk_cfp<void*> texture_ptr;
  texture_ptr.retain((__bridge void*)texture);
  textures_[texture_id] = texture_ptr;
 
  return {
      .texture_id = texture_id,
      .texture = (__bridge void*)texture,
  };
}

References FML_CHECK, height, flutter::size, texture, texture_id, and width.

Referenced by flutter::testing::TEST_F(), and flutter::testing::TEST_F().

GetMetalCommandQueue()

id< MTLCommandQueue > flutter::testing::TestMetalContext::GetMetalCommandQueue

(

)

const

Definition at line 57 of file test_metal_context.mm.

                                                                 {
  return command_queue_;
}

GetMetalDevice()

id< MTLDevice > flutter::testing::TestMetalContext::GetMetalDevice

(

)

const

Definition at line 53 of file test_metal_context.mm.

                                                     {
  return device_;
}

GetSkiaContext()

sk_sp< GrDirectContext > flutter::testing::TestMetalContext::GetSkiaContext

(

)

const

Definition at line 61 of file test_metal_context.mm.

                                                              {
  return skia_context_;
}

Referenced by flutter::testing::TEST_F().

GetTextureInfo()

TestMetalContext::TextureInfo flutter::testing::TestMetalContext::GetTextureInfo

(

int64_t

texture_id

)

Definition at line 115 of file test_metal_context.mm.

                                                                               {
  std::scoped_lock lock(textures_mutex_);
  if (textures_.find(texture_id) == textures_.end()) {
    FML_CHECK(false) << "Invalid texture id: " << texture_id;
    return {.texture_id = -1, .texture = nullptr};
  } else {
    return {
        .texture_id = texture_id,
        .texture = textures_[texture_id].get(),
    };
  }
}

References FML_CHECK, and texture_id.

Present()

bool flutter::testing::TestMetalContext::Present

(

int64_t

texture_id

)

Definition at line 106 of file test_metal_context.mm.

                                                 {
  std::scoped_lock lock(textures_mutex_);
  if (textures_.find(texture_id) == textures_.end()) {
    return false;
  } else {
    return true;
  }
}

References texture_id.

---

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

• testing/test_metal_context.h
• testing/test_metal_context.mm