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

#include <PNGEncoder.hpp>

Public Member Functions
StringView	name () const override
	エンコーダの対応形式 `U"PNG"` を返します。 More...

ImageFormat	imageFormat () const noexcept override
	PNG 形式を示す ImageFormat を返します。 More...

const Array< String > &	possibleExtensions () const override
	PNG 形式のファイルに想定される拡張子一覧 `{ U"png" }` を返します。 More...

bool	save (const Image &image, FilePathView path) const override
	Image を PNG 形式でエンコードしてファイルに保存します。 More...

bool	save (const Image &image, FilePathView path, PNGFilter filter) const
	Image を PNG 形式でエンコードしてファイルに保存します。 More...

bool	save (const Grid< uint16 > &image, FilePathView path, PNGFilter filter=DefaultFilter) const
	16-bit グレースケールデータ (Grid) を PNG 形式でエンコードしてファイルに保存します。 More...

bool	encode (const Image &image, IWriter &writer) const override
	Image を PNG 形式でエンコードして書き出します。 More...

bool	encode (const Image &image, IWriter &writer, PNGFilter filter) const
	Image を PNG 形式でエンコードして書き出します。 More...

bool	encode (const Grid< uint16 > &image, IWriter &writer, PNGFilter filter=DefaultFilter) const
	16-bit グレースケールデータ (Grid) を PNG 形式でエンコードして書き出します。 More...

Blob	encode (const Image &image) const override
	Image を PNG 形式でエンコードした結果を Blob で返します。 More...

Blob	encode (const Image &image, PNGFilter filter) const
	Image を PNG 形式でエンコードした結果を Blob で返します。 More...

Blob	encode (const Grid< uint16 > &image, PNGFilter filter=DefaultFilter) const
	16-bit グレースケールデータ (Grid) を PNG 形式でエンコードした結果を Blob で返します。 More...

Public Member Functions inherited from s3d::IImageEncoder
virtual	~IImageEncoder ()=default

Static Public Attributes
static constexpr PNGFilter	DefaultFilter = PNGFilter::Default
	デフォルトの PNG フィルタ (PNGFilter::Default) More...

Detailed Description

PNG 形式画像のエンコーダ

Member Function Documentation

◆ encode() [1/6]

bool s3d::PNGEncoder::encode	(	const Grid< uint16 > &	image,
		IWriter &	writer,
		PNGFilter	filter = `DefaultFilter`
	)		const

16-bit グレースケールデータ (Grid) を PNG 形式でエンコードして書き出します。

Parameters

image	エンコードする Grid
writer	書き出し先の IWriter インタフェース
filter	使用するフィルタ

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

◆ encode() [2/6]

Blob s3d::PNGEncoder::encode	(	const Grid< uint16 > &	image,
		PNGFilter	filter = `DefaultFilter`
	)		const

16-bit グレースケールデータ (Grid) を PNG 形式でエンコードした結果を Blob で返します。

Parameters

image	エンコードする Grid
filter	使用するフィルタ

Returns: エンコード結果

◆ encode() [3/6]

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

overridevirtual

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

Parameters

image エンコードする Image

Returns: エンコード結果

Implements s3d::IImageEncoder.

◆ encode() [4/6]

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

overridevirtual

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

Parameters

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

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

Implements s3d::IImageEncoder.

◆ encode() [5/6]

bool s3d::PNGEncoder::encode	(	const Image &	image,
		IWriter &	writer,
		PNGFilter	filter
	)		const

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

Parameters

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

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

◆ encode() [6/6]

Blob s3d::PNGEncoder::encode	(	const Image &	image,
		PNGFilter	filter
	)		const

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

Parameters

image	エンコードする Image
filter	使用するフィルタ

Returns: エンコード結果

◆ imageFormat()

ImageFormat s3d::PNGEncoder::imageFormat ( ) const

overridevirtualnoexcept

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

Returns: ImageFormat::PNG

Implements s3d::IImageEncoder.

◆ name()

StringView s3d::PNGEncoder::name ( ) const

overridevirtual

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

Returns: 文字列 U"PNG"

Implements s3d::IImageEncoder.

◆ possibleExtensions()

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

overridevirtual

PNG 形式のファイルに想定される拡張子一覧 { U"png" } を返します。

Returns: 配列 { U"png" }

Implements s3d::IImageEncoder.

◆ save() [1/3]

bool s3d::PNGEncoder::save	(	const Grid< uint16 > &	image,
		FilePathView	path,
		PNGFilter	filter = `DefaultFilter`
	)		const

16-bit グレースケールデータ (Grid) を PNG 形式でエンコードしてファイルに保存します。

Parameters

image	エンコードする Grid
path	保存するファイルのパス
filter	使用するフィルタ

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

◆ save() [2/3]

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

overridevirtual

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

Parameters

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

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

Implements s3d::IImageEncoder.

◆ save() [3/3]

bool s3d::PNGEncoder::save	(	const Image &	image,
		FilePathView	path,
		PNGFilter	filter
	)		const

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

Parameters

image	エンコードする Image
path	保存するファイルのパス
filter	使用するフィルタ

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

Member Data Documentation

◆ DefaultFilter

constexpr PNGFilter s3d::PNGEncoder::DefaultFilter = PNGFilter::Default

staticconstexpr

デフォルトの PNG フィルタ (PNGFilter::Default)

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

OpenSiv3D/Siv3D/include/Siv3D/ImageFormat/PNGEncoder.hpp

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ encode() [1/6]

◆ encode() [2/6]

◆ encode() [3/6]

◆ encode() [4/6]

◆ encode() [5/6]

◆ encode() [6/6]

◆ imageFormat()

◆ name()

◆ possibleExtensions()

◆ save() [1/3]

◆ save() [2/3]

◆ save() [3/3]

Member Data Documentation

◆ DefaultFilter