WIL説明書(C++)  3.0.0
関数
関数
画像ファイルアクセス

詳解

関数

FVCL_API FVCL::ImageSize FVCL::File::CheckImageFileInfo (LPCTSTR szFileName, INT pixelmode=FVCL::PixelMode::Unpacking)
  [[OSS]] 画像ファイルのサイズ情報の読み込み [詳解]
 
FVCL_API INT FVCL::File::LoadImageFile (LPCTSTR szFileName, FVCL::Data::CFvImage *pImage, INT pixelmode=FVCL::PixelMode::Unpacking)
  [[OSS]] 画像ファイルの読み込み [詳解]
 
FVCL_API INT FVCL::File::SaveImageFile (LPCTSTR szFileName, const FVCL::Data::CFvImage &image)
  [[OSS]] 画像ファイルの保存 [詳解]
 
FVCL_API bool FVCL::File::Exists (LPCTSTR szFileName)
 ファイルの存在チェック [詳解]
 
FVCL_API FVCL::Data::CFvString FVCL::File::GetExtension (LPCTSTR szFileName)
 拡張子の抽出 [詳解]
 

関数詳解

FVCL::File::CheckImageFileInfo ( LPCTSTR  szFileName,
INT  pixelmode = FVCL::PixelMode::Unpacking 
)

[[OSS]] 画像ファイルのサイズ情報の読み込み

namespace FVCL::File

指定された画像ファイルを画像オブジェクトに読み込む為に必要となる領域の情報を取得します。

引数
[in]szFileName画像ファイルへのパス
※注) Raw フォーマットの場合は、必ずパスを付加してください。 理由については FVCL::File::CFvImageFileRaw::CheckInfo の解説をご参照ください。
[in]pixelmodeピクセルモード
戻り値
画像サイズ情報を返します。
例外
FVCL::CFveException処理に失敗した場合は例外を発行します。
発行された例外インスタンスの GetErrorCode からエラーコードを取得できます。
エラーコード:
値 定数 内容
51 FVCL_ErrorCode::LICENSE_ERROR fvalg OSS ライブラリ が見つからない為、実行できません。 または、 FVCL::InitVisionLibrary が実行されていません。
11 FVCL_ErrorCode::INVALID_PARAMETER 引数に誤りがあります。
2 FVCL_ErrorCode::FAILED_TO_OPEN 画像ファイルのオープンに失敗しました。
21 FVCL_ErrorCode::NOT_SUPPORTED サポートされていない画像ファイルです。
3 FVCL_ErrorCode::FAILED_TO_READ 画像ファイルの読み込みに失敗しました。
23 FVCL_ErrorCode::NOT_ALLOCATED メモリ不足により領域の確保に失敗しました。
13 FVCL_ErrorCode::INVALID_DATA 画像データが無効です。
必要条件:
ヘッダー: FVCLbasic.h
解説:
引数 szFileName に指定されたファイル名の拡張子によって画像ファイル形式を判断し、 対応する画像ファイルアクセスクラスで読み込みます。 拡張子とクラスの対応は以下の通りです。
  • .bmp : FVCL::File::CFvImageFileBmp
  • .dib : FVCL::File::CFvImageFileBmp
  • .jpg : FVCL::File::CFvImageFileJpg
  • .jpeg : FVCL::File::CFvImageFileJpg
  • .png : FVCL::File::CFvImageFilePng
  • .tif : FVCL::File::CFvImageFileTiff
  • .tiff : FVCL::File::CFvImageFileTiff
  • .raw : FVCL::File::CFvImageFileRaw

引数 pixelmode は、画像ファイルがカラー画像の場合に有効です。 FVCL::PixelMode::Packing が指定された場合は、 FVCL::ImageType::RGB24 または FVCL::ImageType::RGB32 として処理します。 FVCL::PixelMode::Unpacking が指定された場合は、 FVCL::ImageType::UC8 または FVCL::ImageType::US16 の 3 チャネルとして処理します。 本ライブラリの画像処理はチャネル分割された画像データを処理対象とするものが多いので、 FVCL::PixelMode::Unpacking で読み込むことを推奨します。 但し、Raw フォーマットの場合は、 pixelmode は無視されます。
留意事項:
JPEG,PNG,TIFF 画像を読み込む場合は、fvalg_oss_mt が必要です。 これらの DLL は FVCL::InitVisionLibrary を実行した際に自動的にロードされます。 FVCL::InitVisionLibrary が実行されていない場合、 または、これらの DLL をインストールしていない場合は FVCL_ErrorCode::LICENSE_ERROR (51) を返します。
参照
FVCL::File::CFvImageFile::SetPixelMode
FVCL::File::CFvImageFileBmp::CheckInfo
FVCL::File::CFvImageFileRaw::CheckInfo
FVCL::File::CFvImageFilePng::CheckInfo
FVCL::File::CFvImageFileJpg::CheckInfo
FVCL::File::CFvImageFileTiff::CheckInfo
FVCL::File::LoadImageFile ( LPCTSTR  szFileName,
FVCL::Data::CFvImage *  pImage,
INT  pixelmode = FVCL::PixelMode::Unpacking 
)

[[OSS]] 画像ファイルの読み込み

namespace FVCL::File

画像ファイルの内容を画像オブジェクトに読み込みます。
この関数は、簡易的に画像ファイルを読み込む為のものです。 この関数で指定できないパラメータを指定する必要があれば、 各画像ファイルアクセスクラスを直接使用してください。

引数
[in]szFileName画像ファイルへのパス
※注) Raw フォーマットの場合は、必ずパスを付加してください。 理由については FVCL::File::CFvImageFileRaw::Load の解説をご参照ください。
[out]pImage画像データの読み込み先
[in]pixelmodeピクセルモード
戻り値
FVCL_ErrorCode::_SUCCESS正常
FVCL_ErrorCode::INVALID_PARAMETER引数に誤りがあります。
FVCL_ErrorCode::NOT_SUPPORTED指定された画像ファイル形式はサポートしていません。
その他読み込み中に異常が発生した場合は、 各画像ファイルアクセスクラスのエラーコードが返ります。
必要条件:
ヘッダー: FVCLbasic.h
解説:
引数 szFileName に指定されたファイル名の拡張子によって画像ファイル形式を判断し、 対応する画像ファイルアクセスクラスで読み込みます。 拡張子とクラスの対応は以下の通りです。
  • .bmp : FVCL::File::CFvImageFileBmp
  • .dib : FVCL::File::CFvImageFileBmp
  • .jpg : FVCL::File::CFvImageFileJpg
  • .jpeg : FVCL::File::CFvImageFileJpg
  • .png : FVCL::File::CFvImageFilePng
  • .tif : FVCL::File::CFvImageFileTiff
  • .tiff : FVCL::File::CFvImageFileTiff
  • .raw : FVCL::File::CFvImageFileRaw

引数 pixelmode は、画像ファイルがカラー画像の場合に有効です。 FVCL::PixelMode::Packing が指定された場合は、 pImage を FVCL::ImageType::RGB24 または FVCL::ImageType::RGB32 で 確保して読み込みます。 FVCL::PixelMode::Unpacking が指定された場合は、 pImage を FVCL::ImageType::UC8 または FVCL::ImageType::US16 の 3 チャネルで確保して読み込みます。 本ライブラリの画像処理はチャネル分割された画像データを処理対象とするものが多いので、 FVCL::PixelMode::Unpacking で読み込むことを推奨します。 但し、Raw フォーマットの場合は、 pixelmode は無視されます。
留意事項:
JPEG,PNG,TIFF 画像を読み込む場合は、fvalg_oss_mt が必要です。 これらの DLL は FVCL::InitVisionLibrary を実行した際に自動的にロードされます。 FVCL::InitVisionLibrary が実行されていない場合、 または、これらの DLL をインストールしていない場合は FVCL_ErrorCode::LICENSE_ERROR (51) を返します。
参照
FVCL::File::CFvImageFile::SetPixelMode
FVCL::File::CFvImageFileBmp::Load
FVCL::File::CFvImageFileRaw::Load
FVCL::File::CFvImageFileJpg::Load
FVCL::File::CFvImageFilePng::Load
FVCL::File::CFvImageFileTiff::Load
FVCL::File::SaveImageFile ( LPCTSTR  szFileName,
const FVCL::Data::CFvImage &  image 
)

[[OSS]] 画像ファイルの保存

namespace FVCL::File

画像オブジェクトの内容を画像ファイルに保存します。
この関数は、簡易的に画像ファイルの保存を行う為のものです。 この関数で指定できないパラメータを指定する必要があれば、 各画像ファイルアクセスクラスを直接使用してください。

引数
[in]szFileName画像ファイルへのパス
※注) Raw フォーマットの場合は、必ずパスを付加してください。 理由については FVCL::File::CFvImageFileRaw::Save の解説をご参照ください。
[in]image保存する画像データ
戻り値
FVCL_ErrorCode::_SUCCESS正常
FVCL_ErrorCode::INVALID_PARAMETER引数に誤りがあります。
FVCL_ErrorCode::NOT_SUPPORTED指定された画像ファイル形式はサポートしていません。
その他保存中に異常が発生した場合は、 各画像ファイルアクセスクラスのエラーコードが返ります。
必要条件:
ヘッダー: FVCLbasic.h
解説:
引数 szFileName に指定されたファイル名の拡張子によって画像ファイル形式を判断し、 対応する画像ファイルアクセスクラスで保存します。 拡張子とクラスの対応は以下の通りです。
  • .bmp : FVCL::File::CFvImageFileBmp
  • .dib : FVCL::File::CFvImageFileBmp
  • .jpg : FVCL::File::CFvImageFileJpg
  • .jpeg : FVCL::File::CFvImageFileJpg
  • .png : FVCL::File::CFvImageFilePng
  • .tif : FVCL::File::CFvImageFileTiff
  • .tiff : FVCL::File::CFvImageFileTiff
  • .raw : FVCL::File::CFvImageFileRaw

留意事項:
JPEG,PNG,TIFF 画像を保存する場合は、fvalg_oss_mt が必要です。 これらの DLL は FVCL::InitVisionLibrary を実行した際に自動的にロードされます。 FVCL::InitVisionLibrary が実行されていない場合、 または、これらの DLL をインストールしていない場合は FVCL_ErrorCode::LICENSE_ERROR (51) を返します。
参照
FVCL::File::CFvImageFileBmp::Save
FVCL::File::CFvImageFileRaw::Save
FVCL::File::CFvImageFileJpg::Save
FVCL::File::CFvImageFilePng::Save
FVCL::File::CFvImageFileTiff::Save
FVCL::File::Exists ( LPCTSTR  szFileName)

ファイルの存在チェック

namespace FVCL::File

引数
[in]szFileNameファイルパス
戻り値
true存在する
false存在しない
必要条件:
ヘッダー: FVCLbasic.h
FVCL::File::GetExtension ( LPCTSTR  szFileName)

拡張子の抽出

namespace FVCL::File

引数
[in]szFileNameファイルパス
戻り値
取得した拡張子(ドットを含む)を返します。
例えば c:/data/test.bmp の場合は .bmp を返します。
必要条件:
ヘッダー: FVCLbasic.h
Documentation copyright © 2007 FAST Corporation. [B-001864]
Generated on 2023年11月02日(木) 10時12分55秒 for WIL説明書(C++) by doxygen 1.8.11