YSTest: YSLib::Drawing::ImageCodec类 参考

YSTest PreAlpha_b900_20201012 The YSLib Test Project

Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
YSLib::Drawing::ImageCodec类 参考final

`#include <Image.h>`

## Public 成员函数

| ImageCodec ()
| ~ImageCodec ()

## 静态 Public 成员函数

static YB_ATTR_nodiscard ImageFormat | DetectFormat (ImageMemory::NativeHandle, size_t)
| 检测图像格式。 更多...
static YB_ATTR_nodiscard ImageFormat | DetectFormat (const char *)
static YB_ATTR_nodiscard ImageFormat | DetectFormat (const char16_t *)
YB_ATTR_nodiscard static YB_PURE CompactPixmap | Load (ImageMemory::Buffer)
static YB_ATTR_nodiscard HMultiBitmap | LoadForPlaying (const char *)
| 读取指定路径的多页面图片文件为用于直接呈现的帧序列。 更多...
static YB_ATTR_nodiscard HMultiBitmap | LoadForPlaying (const char16_t *)
template<class _tString , yimpl(typename=ystdex::enable_for_string_class_t< _tString >) >
static YB_ATTR_nodiscard HMultiBitmap | LoadForPlaying (const _tString &filename)
| 构造：使用指定字符串文件名。 更多...
template<class _tSeqCon , typename _type >
static YB_ATTR_nodiscard _tSeqCon | LoadSequence (const _type &path)
| 读取指定路径的图片文件为用于直接呈现的帧序列。 更多...

## 详细描述

自从
  build 417

在文件 Image.h 第 951 行定义.

## 构造及析构函数说明

## ◆ ImageCodec()

YSLib::Drawing::ImageCodec::ImageCodec | ( |  | ) |

注解
  初始化时暂存和重置 errno 。

在文件 Image.cpp 第 773 行定义.

## ◆ ~ImageCodec()

YSLib::Drawing::ImageCodec::~ImageCodec | ( |  | ) |

自从
  build 461

在文件 Image.cpp 第 782 行定义.

## 成员函数说明

## ◆ DetectFormat() [1/3]

ImageFormat YSLib::Drawing::ImageCodec::DetectFormat | ( | const char * | filename | ) |

static

注解
  使用指定 UTF-8 文件名。

在文件 Image.cpp 第 794 行定义.

引用了 YSLib::Drawing::Unknown.

## ◆ DetectFormat() [2/3]

ImageFormat YSLib::Drawing::ImageCodec::DetectFormat | ( | const char16_t * | filename | ) |

static

注解
  使用指定 UCS-2 文件名。

在文件 Image.cpp 第 802 行定义.

引用了 YSLib::Drawing::Unknown.

## ◆ DetectFormat() [3/3]

ImageFormat YSLib::Drawing::ImageCodec::DetectFormat | ( | ImageMemory::NativeHandle | handle,
|  | size_t | size
| ) |  |

static

检测图像格式。

注解
  对文件，若根据内容检测失败则根据扩展名判断（不保证正确性）。

自从
  build 457

注解
  使用图像内存的本机句柄和大小。

警告
  参数截断至 `unsigned long` 。

在文件 Image.cpp 第 788 行定义.

引用了 size.

被这些函数引用 YSLib::Drawing::ImageMemory::ImageMemory() , 以及 LoadForPlaying().

这是这个函数的调用关系图:

## ◆ Load()

CompactPixmap YSLib::Drawing::ImageCodec::Load | ( | ImageMemory::Buffer | buf | ) |

static

自从
  build 470

在文件 Image.cpp 第 811 行定义.

引用了 YSLib::Text::buf , 以及 YSLib::Drawing::Unknown.

## ◆ LoadForPlaying() [1/3]

template<class _tString , yimpl(typename=ystdex::enable_for_string_class_t< _tString >) >

static YB_ATTR_nodiscard HMultiBitmap YSLib::Drawing::ImageCodec::LoadForPlaying | ( | const _tString & | filename | ) |

inlinestatic

构造：使用指定字符串文件名。

自从
  build 483

在文件 Image.h 第 1003 行定义.

## ◆ LoadForPlaying() [2/3]

HMultiBitmap YSLib::Drawing::ImageCodec::LoadForPlaying | ( | const char * | path | ) |

static

读取指定路径的多页面图片文件为用于直接呈现的帧序列。

注解
  非多页面读取结果为空。
  对多页面图片自动选择解码器标识（当前仅支持 GIF 格式）；其它为默认参数。

自从
  build 458

注解
  使用指定 UTF-8 文件名。

在文件 Image.cpp 第 821 行定义.

引用了 YSLib::Drawing::Default, DetectFormat(), YSLib::Drawing::GIF, YSLib::Drawing::GIF_Playback , 以及 YSLib::path.

函数调用图:

## ◆ LoadForPlaying() [3/3]

HMultiBitmap YSLib::Drawing::ImageCodec::LoadForPlaying | ( | const char16_t * | path | ) |

static

注解
  使用指定 UCS-2 文件名。

在文件 Image.cpp 第 829 行定义.

引用了 YSLib::Drawing::Default, DetectFormat(), YSLib::Drawing::GIF, YSLib::Drawing::GIF_Playback , 以及 YSLib::path.

函数调用图:

## ◆ LoadSequence()

template<class _tSeqCon , typename _type >

static YB_ATTR_nodiscard _tSeqCon YSLib::Drawing::ImageCodec::LoadSequence | ( | const _type & | path | ) |

inlinestatic

读取指定路径的图片文件为用于直接呈现的帧序列。

注解
  使用 LoadForPlaying 按多页面读取，若结果为空按单页面读取。

参见
  LoadForPlaying

自从
  build 461

在文件 Image.h 第 1017 行定义.

引用了 YSLib::path.

该类的文档由以下文件生成:

- Image.h
- Image.cpp