flutter_texture_registrar.h File Reference

#include <stddef.h>
#include <stdint.h>
#include "flutter_export.h"

Go to the source code of this file.

Classes
struct	FlutterDesktopPixelBuffer
struct	FlutterDesktopGpuSurfaceDescriptor
struct	FlutterDesktopPixelBufferTextureConfig
struct	FlutterDesktopGpuSurfaceTextureConfig
struct	FlutterDesktopTextureInfo

Typedefs
typedef struct FlutterDesktopTextureRegistrar *	FlutterDesktopTextureRegistrarRef
typedef const FlutterDesktopPixelBuffer *(*	FlutterDesktopPixelBufferTextureCallback) (size_t width, size_t height, void *user_data)
typedef const FlutterDesktopGpuSurfaceDescriptor *(*	FlutterDesktopGpuSurfaceTextureCallback) (size_t width, size_t height, void *user_data)

Enumerations
enum	FlutterDesktopTextureType {   kFlutterDesktopPixelBufferTexture ,   kFlutterDesktopGpuSurfaceTexture }
enum	FlutterDesktopGpuSurfaceType {   kFlutterDesktopGpuSurfaceTypeNone ,   kFlutterDesktopGpuSurfaceTypeDxgiSharedHandle ,   kFlutterDesktopGpuSurfaceTypeD3d11Texture2D }
enum	FlutterDesktopPixelFormat {   kFlutterDesktopPixelFormatNone ,   kFlutterDesktopPixelFormatRGBA8888 ,   kFlutterDesktopPixelFormatBGRA8888 }

Functions
FLUTTER_EXPORT int64_t	FlutterDesktopTextureRegistrarRegisterExternalTexture (FlutterDesktopTextureRegistrarRef texture_registrar, const FlutterDesktopTextureInfo *info)
FLUTTER_EXPORT void	FlutterDesktopTextureRegistrarUnregisterExternalTexture (FlutterDesktopTextureRegistrarRef texture_registrar, int64_t texture_id, void(*callback)(void *user_data), void *user_data)
FLUTTER_EXPORT bool	FlutterDesktopTextureRegistrarMarkExternalTextureFrameAvailable (FlutterDesktopTextureRegistrarRef texture_registrar, int64_t texture_id)

Typedef Documentation

FlutterDesktopGpuSurfaceTextureCallback

typedef const FlutterDesktopGpuSurfaceDescriptor*( * FlutterDesktopGpuSurfaceTextureCallback) (size_t width, size_t height, void *user_data)

Definition at line 124 of file flutter_texture_registrar.h.

FlutterDesktopPixelBufferTextureCallback

typedef const FlutterDesktopPixelBuffer*( * FlutterDesktopPixelBufferTextureCallback) (size_t width, size_t height, void *user_data)

Definition at line 115 of file flutter_texture_registrar.h.

FlutterDesktopTextureRegistrarRef

typedef struct FlutterDesktopTextureRegistrar* FlutterDesktopTextureRegistrarRef

Definition at line 20 of file flutter_texture_registrar.h.

Enumeration Type Documentation

FlutterDesktopGpuSurfaceType

enum FlutterDesktopGpuSurfaceType

Enumerator
kFlutterDesktopGpuSurfaceTypeNone
kFlutterDesktopGpuSurfaceTypeDxgiSharedHandle
kFlutterDesktopGpuSurfaceTypeD3d11Texture2D

Definition at line 32 of file flutter_texture_registrar.h.

             {
  // Uninitialized.
  kFlutterDesktopGpuSurfaceTypeNone,
  // A DXGI shared texture handle (Windows only).
  // See
  // https://docs.microsoft.com/en-us/windows/win32/api/dxgi/nf-dxgi-idxgiresource-getsharedhandle
  kFlutterDesktopGpuSurfaceTypeDxgiSharedHandle,
  // A |ID3D11Texture2D| (Windows only).
  kFlutterDesktopGpuSurfaceTypeD3d11Texture2D
} FlutterDesktopGpuSurfaceType;

FlutterDesktopPixelFormat

enum FlutterDesktopPixelFormat

Enumerator
kFlutterDesktopPixelFormatNone
kFlutterDesktopPixelFormatRGBA8888
kFlutterDesktopPixelFormatBGRA8888

Definition at line 44 of file flutter_texture_registrar.h.

             {
  // Uninitialized.
  kFlutterDesktopPixelFormatNone,
  // Represents a 32-bit RGBA color format with 8 bits each for red, green, blue
  // and alpha.
  kFlutterDesktopPixelFormatRGBA8888,
  // Represents a 32-bit BGRA color format with 8 bits each for blue, green, red
  // and alpha.
  kFlutterDesktopPixelFormatBGRA8888
} FlutterDesktopPixelFormat;

FlutterDesktopTextureType

enum FlutterDesktopTextureType

Enumerator
kFlutterDesktopPixelBufferTexture
kFlutterDesktopGpuSurfaceTexture

Definition at line 24 of file flutter_texture_registrar.h.

             {
  // A Pixel buffer-based texture.
  kFlutterDesktopPixelBufferTexture,
  // A platform-specific GPU surface-backed texture.
  kFlutterDesktopGpuSurfaceTexture
} FlutterDesktopTextureType;

Function Documentation

FlutterDesktopTextureRegistrarMarkExternalTextureFrameAvailable()

FLUTTER_EXPORT bool FlutterDesktopTextureRegistrarMarkExternalTextureFrameAvailable	(	FlutterDesktopTextureRegistrarRef	texture_registrar,
		int64_t	texture_id
	)

Definition at line 448 of file flutter_windows.cc.

                        {
  return TextureRegistrarFromHandle(texture_registrar)
      ->MarkTextureFrameAvailable(texture_id);
}

References flutter::FlutterWindowsTextureRegistrar::MarkTextureFrameAvailable(), texture_id, and TextureRegistrarFromHandle().

Referenced by flutter::TextureRegistrarImpl::MarkTextureFrameAvailable().

FlutterDesktopTextureRegistrarRegisterExternalTexture()

FLUTTER_EXPORT int64_t FlutterDesktopTextureRegistrarRegisterExternalTexture	(	FlutterDesktopTextureRegistrarRef	texture_registrar,
		const FlutterDesktopTextureInfo *	info
	)

Definition at line 427 of file flutter_windows.cc.

                                                   {
  return TextureRegistrarFromHandle(texture_registrar)
      ->RegisterTexture(texture_info);
}

References flutter::FlutterWindowsTextureRegistrar::RegisterTexture(), and TextureRegistrarFromHandle().

Referenced by flutter::TextureRegistrarImpl::RegisterTexture().

FlutterDesktopTextureRegistrarUnregisterExternalTexture()

FLUTTER_EXPORT void FlutterDesktopTextureRegistrarUnregisterExternalTexture	(	FlutterDesktopTextureRegistrarRef	texture_registrar,
		int64_t	texture_id,
		void(*)(void *user_data)	callback,
		void *	user_data
	)

Definition at line 434 of file flutter_windows.cc.

                     {
  auto registrar = TextureRegistrarFromHandle(texture_registrar);
  if (callback) {
    registrar->UnregisterTexture(
        texture_id, [callback, user_data]() { callback(user_data); });
    return;
  }
  registrar->UnregisterTexture(texture_id);
}

References callback, texture_id, TextureRegistrarFromHandle(), and user_data.

Referenced by flutter::TextureRegistrarImpl::UnregisterTexture().