FlutterBackBufferCache Class Reference

#include <FlutterSurfaceManager.h>

Inheritance diagram for FlutterBackBufferCache:

Instance Methods
(nullable FlutterSurface *)	- removeSurfaceForSize:
(void)	- returnSurfaces:
(NSUInteger)	- count
(instancetype)	- init [implementation]
(int)	- ageForSurface: [implementation]
(void)	- setAge:forSurface: [implementation]
(void)	- onIdle [implementation]
(void)	- reschedule [implementation]
(void)	- dealloc [implementation]

Protected Attributes
NSMutableArray< FlutterSurface * > *	_surfaces
NSMapTable< FlutterSurface *, NSNumber * > *	_surfaceAge

Detailed Description

Cache of back buffers to prevent unnecessary IOSurface allocations.

Definition at line 81 of file FlutterSurfaceManager.h.

Method Documentation

ageForSurface:

- (int) ageForSurface: (FlutterSurface*)  surface

implementation

Definition at line 277 of file FlutterSurfaceManager.mm.

                    :(FlutterSurface*)surface {
  NSNumber* age = [_surfaceAge objectForKey:surface];
  return age != nil ? age.intValue : 0;
}

count

- (NSUInteger) count

Returns number of surfaces currently in cache. Used for tests.

Definition at line 277 of file FlutterSurfaceManager.mm.

                    {
  @synchronized(self) {
    return _surfaces.count;
  }
}

dealloc

- (void) dealloc

implementation

Definition at line 277 of file FlutterSurfaceManager.mm.

                {
  [NSObject cancelPreviousPerformRequestsWithTarget:self selector:@selector(onIdle) object:nil];
}

init

- (instancetype) init

implementation

Definition at line 277 of file FlutterSurfaceManager.mm.

                     {
  if (self = [super init]) {
    self->_surfaces = [[NSMutableArray alloc] init];
    self->_surfaceAge = [NSMapTable weakToStrongObjectsMapTable];
  }
  return self;
}

onIdle

- (void) onIdle

implementation

Definition at line 277 of file FlutterSurfaceManager.mm.

               {
  @synchronized(self) {
    [_surfaces removeAllObjects];
  }
}

removeSurfaceForSize:

- (nullable FlutterSurface *) removeSurfaceForSize:

(CGSize)

size

Removes surface with given size from cache (if available) and returns it.

Definition at line 277 of file FlutterSurfaceManager.mm.

                                                :(CGSize)size {
  @synchronized(self) {
    // Purge all cached surfaces if the size has changed.
    if (_surfaces.firstObject != nil && !CGSizeEqualToSize(_surfaces.firstObject.size, size)) {
      [_surfaces removeAllObjects];
    }
 
    FlutterSurface* res;
 
    // Returns youngest surface that is not in use. Returning youngest surface ensures
    // that the cache doesn't keep more surfaces than it needs to, as the unused surfaces
    // kept in cache will have their age kept increasing until purged (inside [returnSurfaces:]).
    for (FlutterSurface* surface in _surfaces) {
      if (!surface.isInUse &&
          (res == nil || [self ageForSurface:res] > [self ageForSurface:surface])) {
        res = surface;
      }
    }
    if (res != nil) {
      [_surfaces removeObject:res];
    }
    return res;
  }
}

reschedule

- (void) reschedule

implementation

Definition at line 277 of file FlutterSurfaceManager.mm.

                   {
  [NSObject cancelPreviousPerformRequestsWithTarget:self selector:@selector(onIdle) object:nil];
  [self performSelector:@selector(onIdle) withObject:nil afterDelay:kIdleDelay];
}

returnSurfaces:

- (void) returnSurfaces:

(nonnull NSArray<FlutterSurface*>*)

surfaces

Removes all cached surfaces replacing them with new ones.

Definition at line 277 of file FlutterSurfaceManager.mm.

                      :(nonnull NSArray<FlutterSurface*>*)returnedSurfaces {
  @synchronized(self) {
    for (FlutterSurface* surface in returnedSurfaces) {
      [self setAge:0 forSurface:surface];
    }
    for (FlutterSurface* surface in _surfaces) {
      [self setAge:[self ageForSurface:surface] + 1 forSurface:surface];
    }
 
    [_surfaces addObjectsFromArray:returnedSurfaces];
 
    // Purge all surface with age = kSurfaceEvictionAge. Reaching this age can mean two things:
    // - Surface is still in use and we can't return it. This can happen in some edge
    //   cases where the compositor holds on to the surface for much longer than expected.
    // - Surface is not in use but it hasn't been requested from the cache for a while.
    //   This means there are too many surfaces in the cache.
    [_surfaces filterUsingPredicate:[NSPredicate predicateWithBlock:^BOOL(FlutterSurface* surface,
                                                                          NSDictionary* bindings) {
                 return [self ageForSurface:surface] < kSurfaceEvictionAge;
               }]];
  }
 
  // performSelector:withObject:afterDelay needs to be performed on RunLoop thread
  [self performSelectorOnMainThread:@selector(reschedule) withObject:nil waitUntilDone:NO];
}

setAge:forSurface:

- (void) setAge: (int)  age forSurface: (FlutterSurface*)  surface

implementation

Definition at line 277 of file FlutterSurfaceManager.mm.

              :(int)age forSurface:(FlutterSurface*)surface {
  [_surfaceAge setObject:@(age) forKey:surface];
}

Member Data Documentation

_surfaceAge

- (NSMapTable<FlutterSurface*, NSNumber*>*) _surfaceAge

protected

Provided by category FlutterBackBufferCache().

Definition at line 277 of file FlutterSurfaceManager.mm.

_surfaces

- (NSMutableArray<FlutterSurface*>*) _surfaces

protected

Provided by category FlutterBackBufferCache().

Definition at line 276 of file FlutterSurfaceManager.mm.

---

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

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