Skip to content
22 changes: 16 additions & 6 deletions packages/flame/lib/src/post_process/post_process_component.dart
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import 'package:flame/components.dart';
import 'package:flame/extensions.dart';
import 'package:flame/post_process.dart';
import 'package:flame/src/camera/camera_component.dart';
import 'package:flame/src/game/notifying_vector2.dart';
import 'package:meta/meta.dart';

Expand Down Expand Up @@ -126,18 +125,29 @@ class PostProcessComponentRenderContext<T extends PostProcess>({
}) extends ComponentRenderContext;

extension PostProcessingContextFinder on Component {
/// The post process of type [T] that is currently rendering this component,
/// or `null` if there is none.
///
/// The closest [PostProcessComponent] ancestor is checked first, then the
/// [CameraComponent.postProcess] of the cameras currently rendering, from
/// the innermost to the outermost.
T? findPostProcessFromContext<T extends PostProcess>() {
final closestContext =
findRenderContext<PostProcessComponentRenderContext<T>>();
if (closestContext != null) {
return closestContext.postProcess;
}
final contextInCamera =
findRenderContext<CameraRenderContext>()?.currentPostProcess;
if (contextInCamera is T) {
return contextInCamera;
// The world isn't a child of the camera that renders it, so the camera's
// render context never reaches the world's components. The cameras that
// are rendering are found through [CameraComponent.currentCameras]
// instead.
final cameras = CameraComponent.currentCameras;
for (var i = cameras.length - 1; i >= 0; i--) {
final postProcess = cameras[i].renderContext.currentPostProcess;
if (postProcess is T) {
return postProcess;
}
}

return null;
}
}
137 changes: 137 additions & 0 deletions packages/flame/test/post_process/post_process_context_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
import 'dart:ui';

import 'package:flame/camera.dart';
import 'package:flame/components.dart';
import 'package:flame/post_process.dart';
import 'package:flame_test/flame_test.dart';
import 'package:flutter_test/flutter_test.dart';

void main() {
group('findPostProcessFromContext with CameraComponent.postProcess', () {
testWithFlameGame('is found by components in the world', (game) async {
final postProcess = _TwoPassPostProcess();
final probe = _ContextProbe();
final nestedProbe = _ContextProbe();
game.camera.postProcess = postProcess;
game.world.addAll([
probe,
PositionComponent(children: [nestedProbe]),
]);
await game.ready();

game.render(Canvas(PictureRecorder()));

expect(probe.seen, [postProcess, postProcess]);
expect(nestedProbe.seen, [postProcess, postProcess]);
});

testWithFlameGame('is found by components in the viewfinder', (
game,
) async {
final postProcess = _TwoPassPostProcess();
final probe = _ContextProbe();
game.camera.postProcess = postProcess;
game.camera.viewfinder.add(probe);
await game.ready();

game.render(Canvas(PictureRecorder()));

expect(probe.seen, [postProcess, postProcess]);
});

testWithFlameGame(
'is found from within a PostProcessComponent in the world',
(game) async {
final postProcess = _TwoPassPostProcess();
final probe = _CameraPassProbe();
game.camera.postProcess = postProcess;
game.world.add(
PostProcessComponent(
postProcess: _OtherPostProcess(),
size: Vector2.all(10),
children: [probe],
),
);
await game.ready();

game.render(Canvas(PictureRecorder()));

expect(probe.seen, [postProcess, postProcess]);
},
);

testWithFlameGame(
'is not found by another camera rendering the same world',
(game) async {
final postProcess = _TwoPassPostProcess();
final probe = _ContextProbe();
game.camera.postProcess = postProcess;
game.world.add(probe);
final otherCamera = CameraComponent(world: game.world);
game.add(otherCamera);
await game.ready();

game.render(Canvas(PictureRecorder()));

// Rendered twice by the camera with the post process, then once by
// the camera without it.
expect(probe.seen, [postProcess, postProcess, null]);
},
);

testWithFlameGame(
'is found through a camera nested in the world',
(game) async {
final postProcess = _TwoPassPostProcess();
final probe = _ContextProbe();
final innerWorld = World(children: [probe]);
game.camera.postProcess = postProcess;
game.add(innerWorld);
game.world.add(
CameraComponent(
world: innerWorld,
viewport: FixedSizeViewport(100, 100),
),
);
await game.ready();

game.render(Canvas(PictureRecorder()));

expect(probe.seen, [postProcess, postProcess]);
},
);
});
}

/// Renders its subtree twice.
class _TwoPassPostProcess() extends PostProcess {
@override
void postProcess(Vector2 size, Canvas canvas) {
renderSubtree(canvas);
renderSubtree(canvas);
}
}

/// Renders its subtree once, like any [PostProcess] by default.
class _OtherPostProcess() extends PostProcess;

/// Records the post process it finds in its render context on every render.
class _ContextProbe() extends Component {
final seen = <PostProcess?>[];

@override
void render(Canvas canvas) {
seen.add(findPostProcessFromContext<PostProcess>());
}
}

/// Records the [_TwoPassPostProcess] it finds in its render context on every
/// render.
class _CameraPassProbe() extends Component {
final seen = <PostProcess?>[];

@override
void render(Canvas canvas) {
seen.add(findPostProcessFromContext<_TwoPassPostProcess>());
}
}
Loading