Open Game Engine 2D API
 全部 函数 变量
函数
Image

函数

int OGE_GetImage (string sName)
 通过图片名称取得图片资源
int OGE_LoadImage (string sName, int iWidth, int iHeight, int iColorKeyRGB, string sFileName)
 动态创建图片资源(可从图片文件中加载图像)
string OGE_GetImageName (int iImageId)
 取得图片资源的名称
int OGE_GetColorKey (int iImageId)
 取得图片资源的色键
void OGE_SetColorKey (int iImageId, int iColor)
 设置图片资源的色键
int OGE_GetPenColor (int iImageId)
 取得图片资源的当前画笔颜色
void OGE_SetPenColor (int iImageId, int iColor)
 设置图片资源的当前画笔颜色
int OGE_GetImageFont (int iImageId)
 取得图片的字体
void OGE_SetImageFont (int iImageId, int iFontId)
 设置图片的字体
int OGE_GetImageWidth (int iImageId)
 取得图片的宽度
int OGE_GetImageHeight (int iImageId)
 取得图片的高度
int OGE_GetImageRect (int iImageId)
 取得图片的矩形框
int OGE_GetRect (int x, int y, int w, int h)
 取得矩形框
void OGE_Draw (int iDstImageId, int x, int y, int iSrcImageId, int iRectId)
 把一副图像画到另一副图像上
void OGE_DrawWithEffect (int iDstImageId, int x, int y, int iSrcImageId, int iRectId, int iEffectType, double fEffectValue)
 把一幅图画到另一幅上,并在绘画时使用指定的图形特效
void OGE_FillColor (int iImageId, int iColor)
 使用某一颜色填充图像
void OGE_FillRect (int iImageId, int iRGBColor, int iRectId)
 使用某一颜色填充图像中的指定部分(由矩形框标出)
void OGE_FillRectAlpha (int iImageId, int iRGBColor, int iRectId, int iAlpha)
 用带透明度的颜色来填充图像的指定部分(由矩形框标出)
void OGE_DrawText (int iImageId, string sText, int x, int y)
 在图像上绘画文字
int OGE_GetTextWidth (int iImageId, string sText)
 取得当文字绘画到图像时所占的宽度
bool OGE_GetTextSize (int iImageId, string sText, int &w, int &h)
 取得在绘画文本时,文本所占的矩形框的大小(宽度和高度)
void OGE_DrawBufferText (int iImageId, int iBufferId, int iBufferSize, int x, int y, string sCharsetName)
 把缓冲区中的文本绘画到图像中
int OGE_GetBufferTextWidth (int iImageId, int iBufferId, int iBufferSize, string sCharsetName)
 取得缓冲区中文本的宽度
bool OGE_GetBufferTextSize (int iImageId, int iBufferId, int iBufferSize, string sCharsetName, int &w, int &h)
 取得缓冲区中文本在绘画时所占的矩形框的大小
void OGE_DrawLine (int iImageId, int iStartX, int iStartY, int iEndX, int iEndY)
 在图像上画一条线
void OGE_DrawCircle (int iImageId, int iCenterX, int iCenterY, int iRadius)
 在图像上画圆
int OGE_GetClipboardB ()
 取得图像粘贴板B的ID
int OGE_GetClipboardC ()
 取得图像粘贴板C的ID
void OGE_ImageRGB (int iImageId, int iRectId, int iRed, int iGreen, int iBlue)
 改变图像指定区域的三原色的值(指定区域由矩形框确定)
void OGE_ImageLightness (int iImageId, int iRectId, int iAmount)
 改变图像在指定矩形框区域中的亮度
void OGE_ImageGrayscale (int iImageId, int iRectId, int iAmount)
 使图像的指定区域变灰(指定区域由矩形框确定)
void OGE_ImageBlur (int iImageId, int iRectId, int iAmount)
 使图像的指定区域变模糊(指定区域由矩形框确定)
void OGE_StretchBltToScreen (int iSrcImageId, int iRectId)
 把图像的某一矩形框区域拉伸到屏幕大小,然后再画到屏幕上
void OGE_SaveImageAsBMP (int iImageId, string sBmpFileName)
 把图像保存到BMP格式的文件中
void OGE_RemoveImage (string sName)
 移除一张图片

函数文档

void OGE_Draw ( int  iDstImageId,
int  x,
int  y,
int  iSrcImageId,
int  iRectId 
)

把一副图像画到另一副图像上

参数:
[in]iDstImageId目标图的ID
[in]x绘画位置的纵坐标
[in]y绘画位置的横坐标
[in]iSrcImageId源图的ID
[in]iRectId源图的矩形框的ID
void OGE_DrawBufferText ( int  iImageId,
int  iBufferId,
int  iBufferSize,
int  x,
int  y,
string  sCharsetName 
)

把缓冲区中的文本绘画到图像中

参数:
[in]iImageId图像的ID
[in]iBufferId缓冲区的ID
[in]iBufferSize缓冲区的大小
[in]x绘画位置的横坐标
[in]y绘画位置的纵坐标
[in]sCharsetName文本所用字符集
void OGE_DrawCircle ( int  iImageId,
int  iCenterX,
int  iCenterY,
int  iRadius 
)

在图像上画圆

参数:
[in]iImageId图像的ID
[in]iCenterX圆心的横坐标
[in]iCenterY圆心的纵坐标
[in]iRadius圆的半径
void OGE_DrawLine ( int  iImageId,
int  iStartX,
int  iStartY,
int  iEndX,
int  iEndY 
)

在图像上画一条线

参数:
[in]iImageId图像的ID
[in]iStartX线条的起点横坐标
[in]iStartY线条的起点纵坐标
[in]iEndX线条的终点横坐标
[in]iEndY线条的终点纵坐标
void OGE_DrawText ( int  iImageId,
string  sText,
int  x,
int  y 
)

在图像上绘画文字

参数:
[in]iImageId图像的ID
[in]sText要绘画的文本
[in]x绘画的横坐标
[in]y绘画的纵坐标
void OGE_DrawWithEffect ( int  iDstImageId,
int  x,
int  y,
int  iSrcImageId,
int  iRectId,
int  iEffectType,
double  fEffectValue 
)

把一幅图画到另一幅上,并在绘画时使用指定的图形特效

参数:
[in]iDstImageId目标图像的ID
[in]x绘画位置的横坐标
[in]y绘画位置的纵坐标
[in]iSrcImageId源图像的ID
[in]iRectId源图像的矩形框的ID
[in]iEffectType特效类型
[in]fEffectValue特效数值
void OGE_FillColor ( int  iImageId,
int  iColor 
)

使用某一颜色填充图像

参数:
[in]iImageId图像的ID
[in]iColor要填充的颜色值
void OGE_FillRect ( int  iImageId,
int  iRGBColor,
int  iRectId 
)

使用某一颜色填充图像中的指定部分(由矩形框标出)

参数:
[in]iImageId图像的ID
[in]iRGBColor需要填充的颜色值
[in]iRectId矩形框的ID
void OGE_FillRectAlpha ( int  iImageId,
int  iRGBColor,
int  iRectId,
int  iAlpha 
)

用带透明度的颜色来填充图像的指定部分(由矩形框标出)

参数:
[in]iImageId图像的ID
[in]iRGBColor颜色值(RGB格式)
[in]iRectId矩形框的ID
[in]iAlpha颜色的透明度
bool OGE_GetBufferTextSize ( int  iImageId,
int  iBufferId,
int  iBufferSize,
string  sCharsetName,
int &  w,
int &  h 
)

取得缓冲区中文本在绘画时所占的矩形框的大小

参数:
[in]iImageId图像的ID
[in]iBufferId缓冲区的ID
[in]iBufferSize缓冲区的大小
[in]sCharsetName文本所用字符集
[out]w文本的宽度
[out]h文本的高度
返回:
如执行成功则返回真,否则返回假
int OGE_GetBufferTextWidth ( int  iImageId,
int  iBufferId,
int  iBufferSize,
string  sCharsetName 
)

取得缓冲区中文本的宽度

参数:
[in]iImageId图像的ID
[in]iBufferId缓冲区的ID
[in]iBufferSize缓冲区的大小
[in]sCharsetName文本所用字符集
返回:
文本的宽度

取得图像粘贴板B的ID

返回:
粘贴板B的ID(图像ID)

取得图像粘贴板C的ID

返回:
粘贴板C的ID(图像ID)
int OGE_GetColorKey ( int  iImageId)

取得图片资源的色键

参数:
[in]iImageId图片资源的ID
返回:
图片资源的色键
int OGE_GetImage ( string  sName)

通过图片名称取得图片资源

参数:
[in]sName图片名称
返回:
图片资源的ID
int OGE_GetImageFont ( int  iImageId)

取得图片的字体

参数:
[in]iImageId图片资源的ID
返回:
字体资源的ID
int OGE_GetImageHeight ( int  iImageId)

取得图片的高度

参数:
[in]iImageId图片的ID
返回:
图片的高度
string OGE_GetImageName ( int  iImageId)

取得图片资源的名称

参数:
[in]iImageId图片资源的ID
返回:
返回图片资源的名称
int OGE_GetImageRect ( int  iImageId)

取得图片的矩形框

参数:
[in]iImageId图片的ID
返回:
矩形框的ID
int OGE_GetImageWidth ( int  iImageId)

取得图片的宽度

参数:
[in]iImageId图片的ID
返回:
图片的宽度
int OGE_GetPenColor ( int  iImageId)

取得图片资源的当前画笔颜色

参数:
[in]iImageId图片资源的ID
返回:
图片的画笔颜色值
int OGE_GetRect ( int  x,
int  y,
int  w,
int  h 
)

取得矩形框

参数:
[in]x矩形框左上角的横坐标
[in]y矩形框左上角的纵坐标
[in]w矩形框的宽度
[in]h矩形框的高度
返回:
矩形框的ID
bool OGE_GetTextSize ( int  iImageId,
string  sText,
int &  w,
int &  h 
)

取得在绘画文本时,文本所占的矩形框的大小(宽度和高度)

参数:
[in]iImageId图像的ID
[in]sText将要绘画的文本
[out]w文本的宽度
[out]h文本的高度
返回:
如果执行成功则返回真,否则返回假
int OGE_GetTextWidth ( int  iImageId,
string  sText 
)

取得当文字绘画到图像时所占的宽度

参数:
[in]iImageId图像的ID
[in]sText字符串文本
返回:
文本的宽度
void OGE_ImageBlur ( int  iImageId,
int  iRectId,
int  iAmount 
)

使图像的指定区域变模糊(指定区域由矩形框确定)

参数:
[in]iImageId图像ID
[in]iRectId矩形框ID
[in]iAmount模糊程度
void OGE_ImageGrayscale ( int  iImageId,
int  iRectId,
int  iAmount 
)

使图像的指定区域变灰(指定区域由矩形框确定)

参数:
[in]iImageId图像ID
[in]iRectId矩形框ID
[in]iAmount灰度值
void OGE_ImageLightness ( int  iImageId,
int  iRectId,
int  iAmount 
)

改变图像在指定矩形框区域中的亮度

参数:
[in]iImageId图像ID
[in]iRectId矩形框ID
[in]iAmount亮度值
void OGE_ImageRGB ( int  iImageId,
int  iRectId,
int  iRed,
int  iGreen,
int  iBlue 
)

改变图像指定区域的三原色的值(指定区域由矩形框确定)

参数:
[in]iImageId图像ID
[in]iRectId矩形框的ID
[in]iRed红色变量值
[in]iGreen绿色变量值
[in]iBlue蓝色变量值
int OGE_LoadImage ( string  sName,
int  iWidth,
int  iHeight,
int  iColorKeyRGB,
string  sFileName 
)

动态创建图片资源(可从图片文件中加载图像)

参数:
[in]sName图片资源名称
[in]iWidth图片的宽度
[in]iHeight图片的高度
[in]iColorKeyRGB图片的色键
[in]sFileName所加载的图片文件路径。若不需要从文件加载,可设为空串。
返回:
图片资源的ID
void OGE_RemoveImage ( string  sName)

移除一张图片

参数:
[in]sName图片的名称
void OGE_SaveImageAsBMP ( int  iImageId,
string  sBmpFileName 
)

把图像保存到BMP格式的文件中

参数:
[in]iImageId图像ID
[in]sBmpFileNameBMP文件的路径
void OGE_SetColorKey ( int  iImageId,
int  iColor 
)

设置图片资源的色键

参数:
[in]iImageId图片资源的ID
[in]iColor色键的颜色值
void OGE_SetImageFont ( int  iImageId,
int  iFontId 
)

设置图片的字体

参数:
[in]iImageId图片的ID
[in]iFontId字体的ID
void OGE_SetPenColor ( int  iImageId,
int  iColor 
)

设置图片资源的当前画笔颜色

参数:
[in]iImageId图片资源的ID
[in]iColor画笔的颜色值
void OGE_StretchBltToScreen ( int  iSrcImageId,
int  iRectId 
)

把图像的某一矩形框区域拉伸到屏幕大小,然后再画到屏幕上

参数:
[in]iSrcImageId图像ID
[in]iRectId矩形框ID