From b17acab8848ec1b4b58f640cd98b9057154279a0 Mon Sep 17 00:00:00 2001 From: Chinmay Garde Date: Wed, 3 Jul 2024 13:02:40 -0700 Subject: [PATCH] [Embedder] Document incorrectly named field in FlutterOpenGLFramebuffer. Doesn't rename the field to maintain API compatibility. But adds a bug annotation. Fixes https://github.com/flutter/flutter/issues/148637 --- shell/platform/embedder/embedder.h | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/shell/platform/embedder/embedder.h b/shell/platform/embedder/embedder.h index 069c813a8d2ed..11e40b8a40ba0 100644 --- a/shell/platform/embedder/embedder.h +++ b/shell/platform/embedder/embedder.h @@ -387,9 +387,14 @@ typedef struct { } FlutterOpenGLTexture; typedef struct { - /// The target of the color attachment of the frame-buffer. For example, - /// GL_TEXTURE_2D or GL_RENDERBUFFER. In case of ambiguity when dealing with - /// Window bound frame-buffers, 0 may be used. + /// The format of the color attachment of the frame-buffer. For example, + /// GL_RGBA8. + /// + /// In case of ambiguity when dealing with Window bound frame-buffers, 0 may + /// be used. + /// + /// @bug This field is incorrectly named as "target" when it actually + /// refers to a format. uint32_t target; /// The name of the framebuffer.