FlutterSurface Class Reference

#import <FlutterSurface.h>

Inheritance diagram for FlutterSurface:

Instance Methods
(FlutterMetalTexture)	- asFlutterMetalTexture
(IOSurfaceRef)	- ioSurface [implementation]
(CGSize)	- size [implementation]
(int64_t)	- textureId [implementation]
(BOOL)	- isInUse [implementation]
(BOOL)	- isInUseOverride [implementation]
(void)	- setIsInUseOverride: [implementation]
(instancetype)	- initWithSize:device: [implementation]
(void)	- dealloc [implementation]

Class Methods
(nullable FlutterSurface *)	+ fromFlutterMetalTexture:
(static void)	+ ReleaseSurface [implementation]
(FlutterSurface *)	+ fromFlutterMetalTexture: [implementation]
(IOSurfaceRef)	+ createIOSurfaceWithSize: [implementation]
(id< MTLTexture >)	+ createTextureForIOSurface:size:device: [implementation]

Protected Attributes
CGSize	_size
IOSurfaceRef	_ioSurface
id< MTLTexture >	_texture
BOOL	_isInUseOverride

Detailed Description

Opaque surface type. Can be represented as FlutterMetalTexture to cross the embedder API boundary.

Definition at line 16 of file FlutterSurface.h.

Method Documentation

asFlutterMetalTexture

- (FlutterMetalTexture) asFlutterMetalTexture

Definition at line 53 of file FlutterSurface.mm.

                                             {
  FlutterMetalTexture res;
  memset(&res, 0, sizeof(FlutterMetalTexture));
  res.struct_size = sizeof(FlutterMetalTexture);
  res.texture = (__bridge void*)_texture;
  res.texture_id = self.textureId;
  res.user_data = (void*)CFBridgingRetain(self);
  res.destruction_callback = ReleaseSurface;
  return res;
}

createIOSurfaceWithSize:

+ (IOSurfaceRef) createIOSurfaceWithSize: (CGSize)  size

implementation

Definition at line 53 of file FlutterSurface.mm.

                                       :(CGSize)size {
  unsigned pixelFormat = 'BGRA';
  unsigned bytesPerElement = 4;
 
  size_t bytesPerRow = IOSurfaceAlignProperty(kIOSurfaceBytesPerRow, size.width * bytesPerElement);
  size_t totalBytes = IOSurfaceAlignProperty(kIOSurfaceAllocSize, size.height * bytesPerRow);
  NSDictionary* options = @{
    (id)kIOSurfaceWidth : @(size.width),
    (id)kIOSurfaceHeight : @(size.height),
    (id)kIOSurfacePixelFormat : @(pixelFormat),
    (id)kIOSurfaceBytesPerElement : @(bytesPerElement),
    (id)kIOSurfaceBytesPerRow : @(bytesPerRow),
    (id)kIOSurfaceAllocSize : @(totalBytes),
  };
 
  IOSurfaceRef res = IOSurfaceCreate((CFDictionaryRef)options);
  IOSurfaceSetValue(res, CFSTR("IOSurfaceColorSpace"), kCGColorSpaceSRGB);
  return res;
}

createTextureForIOSurface:size:device:

+ (id< MTLTexture >) createTextureForIOSurface: (IOSurfaceRef)  surface size: (CGSize)  size device: (id<MTLDevice>)  device

implementation

Definition at line 53 of file FlutterSurface.mm.

                                           :(IOSurfaceRef)surface
                                       size:(CGSize)size
                                     device:(id<MTLDevice>)device {
  MTLTextureDescriptor* textureDescriptor =
      [MTLTextureDescriptor texture2DDescriptorWithPixelFormat:MTLPixelFormatBGRA8Unorm
                                                         width:size.width
                                                        height:size.height
                                                     mipmapped:NO];
  textureDescriptor.usage =
      MTLTextureUsageShaderRead | MTLTextureUsageRenderTarget | MTLTextureUsageShaderWrite;
  // plane = 0 for BGRA.
  return [device newTextureWithDescriptor:textureDescriptor iosurface:surface plane:0];
}

dealloc

- (void) dealloc

implementation

Definition at line 53 of file FlutterSurface.mm.

                {
  CFRelease(_ioSurface);
}

fromFlutterMetalTexture: [1/2]

+ (FlutterSurface *) fromFlutterMetalTexture: (const FlutterMetalTexture*)  texture

implementation

Definition at line 53 of file FlutterSurface.mm.

                                          :(const FlutterMetalTexture*)texture {
  return (__bridge FlutterSurface*)texture->user_data;
}

fromFlutterMetalTexture: [2/2]

+ (nullable FlutterSurface *) fromFlutterMetalTexture:

(nonnull const FlutterMetalTexture *)

texture

initWithSize:device:

- (instancetype) initWithSize: (CGSize)  size device: (id<MTLDevice>)  device

implementation

Provided by category FlutterSurface(Private).

Definition at line 14 of file FlutterSurface.mm.

                            :(CGSize)size device:(id<MTLDevice>)device {
  if (self = [super init]) {
    self->_size = size;
    self->_ioSurface = [FlutterSurface createIOSurfaceWithSize:size];
    self->_texture = [FlutterSurface createTextureForIOSurface:_ioSurface size:size device:device];
  }
  return self;
}

ioSurface

- (IOSurfaceRef) ioSurface

implementation

Provided by category FlutterSurface(Private).

Definition at line 14 of file FlutterSurface.mm.

                          {
  return _ioSurface;
}

isInUse

- (BOOL) isInUse

implementation

Provided by category FlutterSurface(Private).

Definition at line 14 of file FlutterSurface.mm.

                {
  return _isInUseOverride || IOSurfaceIsInUse(_ioSurface);
}

isInUseOverride

- (BOOL) isInUseOverride

implementation

Provided by category FlutterSurface(Testing).

Definition at line 14 of file FlutterSurface.mm.

                        {
  return _isInUseOverride;
}

ReleaseSurface

+ (static void) ReleaseSurface (void *)  surface

implementation

Definition at line 53 of file FlutterSurface.mm.

                                          {
  if (surface != nullptr) {
    CFBridgingRelease(surface);
  }
}

setIsInUseOverride:

- (void) setIsInUseOverride: (BOOL)  isInUseOverride

implementation

Definition at line 14 of file FlutterSurface.mm.

                          :(BOOL)isInUseOverride {
  _isInUseOverride = isInUseOverride;
}

size

- (CGSize) size

implementation

Provided by category FlutterSurface(Private).

Definition at line 14 of file FlutterSurface.mm.

               {
  return _size;
}

textureId

- (int64_t) textureId

implementation

Provided by category FlutterSurface(Private).

Definition at line 14 of file FlutterSurface.mm.

                     {
  return reinterpret_cast<int64_t>(_texture);
}

Member Data Documentation

_ioSurface

- (IOSurfaceRef) _ioSurface

protected

Definition at line 11 of file FlutterSurface.mm.

_isInUseOverride

- (BOOL) _isInUseOverride

protected

Definition at line 14 of file FlutterSurface.mm.

_size

- (CGSize) _size

protected

Definition at line 10 of file FlutterSurface.mm.

_texture

- (id<MTLTexture>) _texture

protected

Definition at line 12 of file FlutterSurface.mm.

---

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

• shell/platform/darwin/macos/framework/Source/FlutterSurface.h
• shell/platform/darwin/macos/framework/Source/FlutterSurface.mm