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

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

#include <JPEGEncoder.hpp>

Inherits s3d::IImageEncoder.

Public Member Functions

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

Static Public Attributes

static constexpr int32 DefaultQuality = 90
 デフォルトのエンコード品質 (90) More...
 

Detailed Description

JPEG 形式画像のエンコーダ

Member Function Documentation

◆ encode() [1/4]

Blob s3d::JPEGEncoder::encode ( const Image image) const
overridevirtual

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

Parameters
imageエンコードする Image
Returns
エンコード結果

Implements s3d::IImageEncoder.

◆ encode() [2/4]

Blob s3d::JPEGEncoder::encode ( const Image image,
int32  quality 
) const

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

Parameters
imageエンコードする Image
qualityエンコード品質 [0, 100], 低いと低画質高圧縮
Returns
エンコード結果

◆ encode() [3/4]

bool s3d::JPEGEncoder::encode ( const Image image,
IWriter writer 
) const
overridevirtual

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

Parameters
imageエンコードする Image
writer書き出し先の IWriter インタフェース
Returns
書き出しに成功した場合 true, それ以外の場合は false

Implements s3d::IImageEncoder.

◆ encode() [4/4]

bool s3d::JPEGEncoder::encode ( const Image image,
IWriter writer,
int32  quality 
) const

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

Parameters
imageエンコードする Image
writer書き出し先の IWriter インタフェース
qualityエンコード品質 [0, 100], 低いと低画質高圧縮
Returns
書き出しに成功した場合 true, それ以外の場合は false

◆ imageFormat()

ImageFormat s3d::JPEGEncoder::imageFormat ( ) const
overridevirtualnoexcept

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

Returns
ImageFormat::JPEG

Implements s3d::IImageEncoder.

◆ name()

StringView s3d::JPEGEncoder::name ( ) const
overridevirtual

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

Returns
文字列 U"JPEG"

Implements s3d::IImageEncoder.

◆ possibleExtensions()

const Array<String>& s3d::JPEGEncoder::possibleExtensions ( ) const
overridevirtual

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

Returns
配列 { U"jpg", U"jpeg" }

Implements s3d::IImageEncoder.

◆ save() [1/2]

bool s3d::JPEGEncoder::save ( const Image image,
FilePathView  path 
) const
overridevirtual

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

Parameters
imageエンコードする Image
path保存するファイルのパス
Returns
保存に成功した場合 true, それ以外の場合は false

Implements s3d::IImageEncoder.

◆ save() [2/2]

bool s3d::JPEGEncoder::save ( const Image image,
FilePathView  path,
int32  quality 
) const

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

Parameters
imageエンコードする Image
path保存するファイルのパス
qualityエンコード品質 [0, 100], 低いと低画質高圧縮
Returns
保存に成功した場合 true, それ以外の場合は false

Member Data Documentation

◆ DefaultQuality

constexpr int32 s3d::JPEGEncoder::DefaultQuality = 90
staticconstexpr

デフォルトのエンコード品質 (90)


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