s3d::PPMEncoder Class Reference

PPM 形式画像のエンコーダ More...

#include <PPMEncoder.hpp>

Inherits s3d::IImageEncoder.

Public Member Functions
StringView	name () const override
	エンコーダの対応形式 U"PPM" を返します。 More...
ImageFormat	imageFormat () const noexcept override
	PPM 形式を示す ImageFormat を返します。 More...
const Array< String > &	possibleExtensions () const override
	PPM 形式のファイルに想定される拡張子一覧 { U"ppm", U"pgm", U"pbm", U"pnm" } を返します。 More...
bool	save (const Image &image, FilePathView path) const override
	Image を PPM 形式でエンコードしてファイルに保存します。 More...
bool	save (const Image &image, FilePathView path, PPMType format) const
	Image を PPM 形式でエンコードしてファイルに保存します。 More...
bool	encode (const Image &image, IWriter &writer) const override
	Image を PPM 形式でエンコードして書き出します。 More...
bool	encode (const Image &image, IWriter &writer, PPMType format) const
	Image を PPM 形式でエンコードして書き出します。 More...
Blob	encode (const Image &image) const override
	Image を PPM 形式でエンコードした結果を Blob で返します。 More...
Blob	encode (const Image &image, PPMType format) const
	Image を PPM 形式でエンコードした結果を Blob で返します。 More...
Public Member Functions inherited from s3d::IImageEncoder
virtual	~IImageEncoder ()=default

Static Public Attributes
static constexpr PPMType	DefaultFromat = PPMType::AsciiRGB
	デフォルトの PPM フォーマット (PPMType::AsciiRGB) More...

Detailed Description

PPM 形式画像のエンコーダ

Member Function Documentation

encode() [1/4]

Blob s3d::PPMEncoder::encode ( const Image &  image ) const

overridevirtual

Image を PPM 形式でエンコードした結果を Blob で返します。

Parameters

image

エンコードする Image

Returns

エンコード結果

Implements s3d::IImageEncoder.

encode() [2/4]

bool s3d::PPMEncoder::encode ( const Image &  image, IWriter &  writer  ) const

overridevirtual

Image を PPM 形式でエンコードして書き出します。

Parameters

image	エンコードする Image
writer	書き出し先の IWriter インタフェース

Returns

書き出しに成功した場合 true, それ以外の場合は false

Implements s3d::IImageEncoder.

encode() [3/4]

bool s3d::PPMEncoder::encode	(	const Image &	image,
		IWriter &	writer,
		PPMType	format
	)		const

Image を PPM 形式でエンコードして書き出します。

Parameters

image	エンコードする Image
writer	書き出し先の IWriter インタフェース
format	PPM フォーマット

Returns

書き出しに成功した場合 true, それ以外の場合は false

encode() [4/4]

Blob s3d::PPMEncoder::encode	(	const Image &	image,
		PPMType	format
	)		const

Image を PPM 形式でエンコードした結果を Blob で返します。

Parameters

image	エンコードする Image
format	PPM フォーマット

Returns

エンコード結果

imageFormat()

ImageFormat s3d::PPMEncoder::imageFormat ( ) const

overridevirtualnoexcept

PPM 形式を示す ImageFormat を返します。

Returns

ImageFormat::PPM

Implements s3d::IImageEncoder.

name()

StringView s3d::PPMEncoder::name ( ) const

overridevirtual

エンコーダの対応形式 U"PPM" を返します。

Returns

文字列 U"PPM"

Implements s3d::IImageEncoder.

possibleExtensions()

const Array<String>& s3d::PPMEncoder::possibleExtensions ( ) const

overridevirtual

PPM 形式のファイルに想定される拡張子一覧 { U"ppm", U"pgm", U"pbm", U"pnm" } を返します。

Returns

配列 { U"ppm", U"pgm", U"pbm", U"pnm" }

Implements s3d::IImageEncoder.

save() [1/2]

bool s3d::PPMEncoder::save ( const Image &  image, FilePathView  path  ) const

overridevirtual

Image を PPM 形式でエンコードしてファイルに保存します。

Parameters

image	エンコードする Image
path	保存するファイルのパス

Returns

保存に成功した場合 true, それ以外の場合は false

Implements s3d::IImageEncoder.

save() [2/2]

bool s3d::PPMEncoder::save	(	const Image &	image,
		FilePathView	path,
		PPMType	format
	)		const

Image を PPM 形式でエンコードしてファイルに保存します。

Parameters

image	エンコードする Image
path	保存するファイルのパス
format	PPM フォーマット

Returns

保存に成功した場合 true, それ以外の場合は false

Member Data Documentation

DefaultFromat

constexpr PPMType s3d::PPMEncoder::DefaultFromat = PPMType::AsciiRGB

staticconstexpr

デフォルトの PPM フォーマット (PPMType::AsciiRGB)

---

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

• OpenSiv3D/Siv3D/include/Siv3D/ImageFormat/PPMEncoder.hpp