flutter::TestMetalContext Class Reference

#include <test_metal_context.h>

Classes
struct	TextureInfo

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

Detailed Description

Definition at line 16 of file test_metal_context.h.

Constructor & Destructor Documentation

TestMetalContext()

flutter::TestMetalContext::TestMetalContext

(

)

Definition at line 19 of file test_metal_context.mm.

                                   {
  auto device = fml::scoped_nsprotocol{MTLCreateSystemDefaultDevice()};
  if (!device) {
    FML_LOG(ERROR) << "Could not acquire Metal device.";
    return;
  }
 
  auto command_queue = fml::scoped_nsobject{[device.get() newCommandQueue]};
  if (!command_queue) {
    FML_LOG(ERROR) << "Could not create the default command queue.";
    return;
  }
 
  [command_queue.get() 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.reset([device.get() retain]);
  backendContext.fQueue.reset([command_queue.get() retain]);
  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.get() retain];
  command_queue_ = [command_queue.get() retain];
}

~TestMetalContext()

flutter::TestMetalContext::~TestMetalContext

(

)

Definition at line 49 of file test_metal_context.mm.

                                    {
  std::scoped_lock lock(textures_mutex_);
  textures_.clear();
  if (device_) {
    [(__bridge id)device_ release];
  }
  if (command_queue_) {
    [(__bridge id)command_queue_ release];
  }
}

Member Function Documentation

CreateMetalTexture()

TestMetalContext::TextureInfo flutter::TestMetalContext::CreateMetalTexture

(

const SkISize &

size

)

Returns texture_id = -1 when texture creation fails.

Definition at line 72 of file test_metal_context.mm.

                                                                                    {
  std::scoped_lock lock(textures_mutex_);
  auto texture_descriptor = fml::scoped_nsobject{
      [[MTLTextureDescriptor texture2DDescriptorWithPixelFormat:MTLPixelFormatBGRA8Unorm
                                                          width:size.width()
                                                         height:size.height()
                                                      mipmapped:NO] retain]};
 
  // 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.get().usage = MTLTextureUsageUnknown;
 
  if (!texture_descriptor) {
    FML_CHECK(false) << "Invalid texture descriptor.";
    return {.texture_id = -1, .texture = nullptr};
  }
 
  id<MTLDevice> device = (__bridge id<MTLDevice>)GetMetalDevice();
  sk_cfp<void*> texture = sk_cfp<void*>{[device newTextureWithDescriptor:texture_descriptor.get()]};
 
  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_++;
  textures_[texture_id] = texture;
 
  return {
      .texture_id = texture_id,
      .texture = texture.get(),
  };
}

GetMetalCommandQueue()

void * flutter::TestMetalContext::GetMetalCommandQueue

(

)

const

Definition at line 64 of file test_metal_context.mm.

                                                   {
  return command_queue_;
}

GetMetalDevice()

void * flutter::TestMetalContext::GetMetalDevice

(

)

const

Definition at line 60 of file test_metal_context.mm.

                                             {
  return device_;
}

GetSkiaContext()

sk_sp< GrDirectContext > flutter::TestMetalContext::GetSkiaContext

(

)

const

Definition at line 68 of file test_metal_context.mm.

                                                              {
  return skia_context_;
}

GetTextureInfo()

TestMetalContext::TextureInfo flutter::TestMetalContext::GetTextureInfo

(

int64_t

texture_id

)

Definition at line 117 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(),
    };
  }
}

Present()

bool flutter::TestMetalContext::Present

(

int64_t

texture_id

)

Definition at line 108 of file test_metal_context.mm.

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

---

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

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