Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

CameraFeed

继承： RefCounted < Object

通过相机源，你可以访问连接到设备的单个物理相机。

描述

相机源允许访问连接到设备的单个物理相机。启用后，Godot 将开始从该相机捕获帧，随后这些帧便可被使用。另见 CameraServer。

注意：很多相机会返回 YCbCr 图像，这些图像被拆分为两个纹理，需要在着色器中进行组合。若将环境设置为在背景中显示相机图像，Godot 会自动执行此操作。

注意：该类目前仅在 Linux、Android、macOS 和 iOS 上实现。在其他平台上 CameraFeed 将不可用。若要在 iOS 上获取 CameraFeed，请启用 EditorExportPlatformIOS.modules/camera。

属性

bool

feed_is_active

false

Transform2D

feed_transform

Transform2D(1, 0, 0, -1, 0, 1)

Array

formats

[]

方法

bool

_activate_feed() virtual

void

_deactivate_feed() virtual

Array

_get_formats() virtual const

bool

_set_format(index: int, parameters: Dictionary) virtual

FeedDataType

get_datatype() const

int

get_id() const

String

get_name() const

FeedPosition

get_position() const

int

get_texture_tex_id(feed_image_type: FeedImage)

void

set_external(width: int, height: int)

bool

set_format(index: int, parameters: Dictionary)

void

set_name(name: String)

void

set_position(position: FeedPosition)

void

set_rgb_image(rgb_image: Image)

void

set_ycbcr_image(ycbcr_image: Image)

void

set_ycbcr_images(y_image: Image, cbcr_image: Image)

信号

format_changed() 🔗

格式发生变化时发出。

frame_changed() 🔗

新图像帧可用时发出。

枚举

enum FeedDataType: 🔗

FeedDataType FEED_NOIMAGE = 0

没有为该源设置图像。

FeedDataType FEED_RGB = 1

源提供 RGB 图像。

FeedDataType FEED_YCBCR = 2

源提供的 YCbCr 图像需要转换成 RGB 图像。

FeedDataType FEED_YCBCR_SEP = 3

源提供单独的 Y 和 CbCr 图像，需要合并并转换为 RGB。

FeedDataType FEED_EXTERNAL = 4

源提供外部图像。

enum FeedPosition: 🔗

FeedPosition FEED_UNSPECIFIED = 0

未指定坐标。

FeedPosition FEED_FRONT = 1

相机安装在了设备前部。

FeedPosition FEED_BACK = 2

相机安装在了设备后部。

属性说明

bool feed_is_active = false 🔗

  • void set_active(value: bool)

  • bool is_active()

如果为 true，则源是激活的。

Transform2D feed_transform = Transform2D(1, 0, 0, -1, 0, 1) 🔗

应用于相机图像的变换。

Array formats = [] 🔗

源支持的所有格式。每个条目都是描述格式参数的 Dictionary。

方法说明

bool _activate_feed() virtual 🔗

相机源被激活时调用。

void _deactivate_feed() virtual 🔗

相机源失去激活时调用。

Array _get_formats() virtual const 🔗

覆盖该方法以定义相机源支持的格式。

bool _set_format(index: int, parameters: Dictionary) virtual 🔗

覆盖该方法以设置相机源的格式。

FeedDataType get_datatype() const 🔗

返回源图像的数据类型。

int get_id() const 🔗

返回该源的唯一ID。

String get_name() const 🔗

返回相机的名称。

FeedPosition get_position() const 🔗

返回设备上的相机位置。

int get_texture_tex_id(feed_image_type: FeedImage) 🔗

返回纹理后端的 ID（可用于某些需要通过纹理句柄写入数据的外部库）。

void set_external(width: int, height: int) 🔗

将供给设置为由另一个库提供的外部供给。

bool set_format(index: int, parameters: Dictionary) 🔗

设置 formats 数组中给定 index 的源格式参数。成功时返回 true。默认情况下，YUYV 编码的流会转换为 FEED_RGB。YUYV 编码的流的输出格式可以通过将 parameters 的 output 条目设置为以下之一来更改：

void set_name(name: String) 🔗

设置相机的名称。

void set_position(position: FeedPosition) 🔗

设置相机的位置。

void set_rgb_image(rgb_image: Image) 🔗

设置该源的 RGB 图像。

void set_ycbcr_image(ycbcr_image: Image) 🔗

设置该源的 YCbCr 图像。

void set_ycbcr_images(y_image: Image, cbcr_image: Image) 🔗

设置该源的 Y 和 CbCr 图像。