OpenSiv3D  v0.6.5
C++20 framework for creative coding
s3d::VideoWriter Class Reference

動画ファイルの書き出し More...

#include <VideoWriter.hpp>

Public Member Functions

SIV3D_NODISCARD_CXX20 VideoWriter ()
 デフォルトコンストラクタ More...
 
SIV3D_NODISCARD_CXX20 VideoWriter (FilePathView path, const Size &size, double fps)
 
bool open (FilePathView path, const Size &size, double fps)
 
void close ()
 動画ファイルをクローズします。 More...
 
bool isOpen () const noexcept
 ファイルがオープンしているかを返します。 More...
 
 operator bool () const noexcept
 ファイルがオープンしているかを返します。 More...
 
bool writeFrame (const Image &image)
 動画ファイルにフレームを書き出します。 More...
 
Size getSize () const noexcept
 動画の解像度を返します。 More...
 
double getFPS () const noexcept
 動画の FPS を返します。 More...
 
const FilePathpath () const noexcept
 動画ファイルのフルパスを返します。 More...
 

Detailed Description

動画ファイルの書き出し

Constructor & Destructor Documentation

◆ VideoWriter() [1/2]

SIV3D_NODISCARD_CXX20 s3d::VideoWriter::VideoWriter ( )

デフォルトコンストラクタ

◆ VideoWriter() [2/2]

SIV3D_NODISCARD_CXX20 s3d::VideoWriter::VideoWriter ( FilePathView  path,
const Size size,
double  fps 
)
explicit

Member Function Documentation

◆ close()

void s3d::VideoWriter::close ( )

動画ファイルをクローズします。

◆ getFPS()

double s3d::VideoWriter::getFPS ( ) const
noexcept

動画の FPS を返します。

Returns
動画の FPS

◆ getSize()

Size s3d::VideoWriter::getSize ( ) const
noexcept

動画の解像度を返します。

Returns
動画の解像度

◆ isOpen()

bool s3d::VideoWriter::isOpen ( ) const
noexcept

ファイルがオープンしているかを返します。

Returns
ファイルがオープンしている場合 true, それ以外の場合は false

◆ open()

bool s3d::VideoWriter::open ( FilePathView  path,
const Size size,
double  fps 
)

◆ operator bool()

s3d::VideoWriter::operator bool ( ) const
explicitnoexcept

ファイルがオープンしているかを返します。

Remarks
isOpen() と同じです。
Returns
ファイルがオープンしている場合 true, それ以外の場合は false

◆ path()

const FilePath& s3d::VideoWriter::path ( ) const
noexcept

動画ファイルのフルパスを返します。

Returns
動画ファイルのフルパス

◆ writeFrame()

bool s3d::VideoWriter::writeFrame ( const Image image)

動画ファイルにフレームを書き出します。

Parameters
image書き出すフレーム
Returns
書き出しに成功した場合 true, それ以外の場合は false

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