s3d::Webcam Class Reference

Web カメラ More...

#include <Webcam.hpp>

Public Types
enum	Permission { Permission::Allowed, Permission::Denied }

Public Member Functions
SIV3D_NODISCARD_CXX20	Webcam ()
SIV3D_NODISCARD_CXX20	Webcam (uint32 cameraIndex, StartImmediately startImmediately=StartImmediately::No)
SIV3D_NODISCARD_CXX20	Webcam (uint32 cameraIndex, const Size &targetResolution, StartImmediately startImmediately=StartImmediately::No)
	~Webcam ()
Optional< Permission >	getPermission () const
	Web カメラの使用権限を返します。 More...
bool	open (uint32 cameraIndex)
	Web カメラを起動します。 More...
void	close ()
	Web カメラをオフにします。 More...
bool	isOpen () const
	Web カメラが起動しているかを返します。 More...
	operator bool () const
	Web カメラが起動しているかを返します。 More...
bool	start ()
	Web カメラによる撮影を開始します。 More...
bool	isActive () const
	Web カメラが撮影中であるかを返します。 More...
uint32	cameraIndex () const
	Web カメラのデバイスインデックスを返します。 More...
Size	getResolution () const
	Web カメラの撮影解像度を返します。 More...
bool	setResolution (int32 width, int32 height)
	Web カメラの撮影解像度の変更をリクエストします。 More...
bool	setResolution (Size resolution)
	Web カメラの撮影解像度の変更をリクエストします。 More...
bool	hasNewFrame () const
	新しく撮影された画像があるかを返します。 More...
bool	getFrame (Image &image)
	最新の撮影された画像を取得します。 More...
bool	getFrame (DynamicTexture &texture)
	最新の撮影された画像を取得します。 More...

Detailed Description

Web カメラ

Member Enumeration Documentation

Permission

enum s3d::Webcam::Permission

strong

Enumerator
Allowed
Denied

Constructor & Destructor Documentation

Webcam() [1/3]

SIV3D_NODISCARD_CXX20 s3d::Webcam::Webcam

(

)

Webcam() [2/3]

SIV3D_NODISCARD_CXX20 s3d::Webcam::Webcam ( uint32  cameraIndex, StartImmediately  startImmediately = StartImmediately::No  )

explicit

Webcam() [3/3]

SIV3D_NODISCARD_CXX20 s3d::Webcam::Webcam	(	uint32	cameraIndex,
		const Size &	targetResolution,
		StartImmediately	startImmediately = StartImmediately::No
	)

~Webcam()

s3d::Webcam::~Webcam

(

)

Member Function Documentation

cameraIndex()

uint32 s3d::Webcam::cameraIndex

(

)

const

Web カメラのデバイスインデックスを返します。

Returns

Web カメラのデバイスインデックス

close()

void s3d::Webcam::close

(

)

Web カメラをオフにします。

getFrame() [1/2]

bool s3d::Webcam::getFrame

(

DynamicTexture &

texture

)

最新の撮影された画像を取得します。

Parameters

texture

画像の格納先

Returns

画像の取得に成功した場合 true, それ以外の場合は false

getFrame() [2/2]

bool s3d::Webcam::getFrame

(

Image &

image

)

最新の撮影された画像を取得します。

Parameters

image

画像の格納先

Returns

画像の取得に成功した場合 true, それ以外の場合は false

getPermission()

Optional<Permission> s3d::Webcam::getPermission

(

)

const

Web カメラの使用権限を返します。

Returns

許可されている場合 Permission::Allowed, 拒否されている場合 Permission::Denied, 権限をリクエスト中である場合 none

getResolution()

Size s3d::Webcam::getResolution

(

)

const

Web カメラの撮影解像度を返します。

Returns

Web カメラの撮影解像度

hasNewFrame()

bool s3d::Webcam::hasNewFrame

(

)

const

新しく撮影された画像があるかを返します。

Returns

新しく撮影された画像がある場合 true, それ以外の場合は false

isActive()

bool s3d::Webcam::isActive

(

)

const

Web カメラが撮影中であるかを返します。

Returns

Web カメラが撮影中である場合 true, それ以外の場合は false

isOpen()

bool s3d::Webcam::isOpen

(

)

const

Web カメラが起動しているかを返します。

Returns

Web カメラが起動している場合 true, それ以外の場合は false

open()

bool s3d::Webcam::open

(

uint32

cameraIndex

)

Web カメラを起動します。

Parameters

cameraIndex

カメラのデバイスインデックス

Returns

operator bool()

s3d::Webcam::operator bool ( ) const

explicit

Web カメラが起動しているかを返します。

Remarks

Webcam::isOpen() と同じです。

Returns

Web カメラが起動している場合 true, それ以外の場合は false

setResolution() [1/2]

bool s3d::Webcam::setResolution	(	int32	width,
		int32	height
	)

Web カメラの撮影解像度の変更をリクエストします。

Parameters

width	幅（ピクセル）
height	高さ（ピクセル）

Returns

リクエストした解像度に変更できた場合 true, それ以外の場合は false

setResolution() [2/2]

bool s3d::Webcam::setResolution

(

Size

resolution

)

Web カメラの撮影解像度の変更をリクエストします。

Parameters

resolution

解像度

Returns

リクエストした解像度に変更できた場合 true, それ以外の場合は false

start()

bool s3d::Webcam::start

(

)

Web カメラによる撮影を開始します。

Returns

すでに撮影中であるか、撮影の開始に成功した場合 true, それ以外の場合は false

---

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

• OpenSiv3D/Siv3D/include/Siv3D/Webcam.hpp