Graphics2D ライブラリ

• 概要 - Abstruct
• 目次 - Index
• 構造体 - Structs
• 変数 - Variables
• 関数 - Functions
• 実装コード

概要 - Abstract

VCSSL Graphics2D ライブラリ は、VCSSLで描画を扱うための標準ライブラリの一つであり、アニメーション対応の2次元コンピュータグラフィックス（2DCG）描画機能を提供します。

Graphics2Dライブラリの規模は比較的大きいため、ここに記載されている関数仕様だけを参考にして扱うのは困難です。具体的な使用方法については、「 VCSSL公式開発ガイド 」をご参照ください。

目次 - Index

int newGraphics2DRenderer( int width, int height, int graphicsID )

2DCGレンダラーを生成し、固有の識別番号（ レンダラーID ）を割り振って返します。

void deleteGraphics2DRenderer( int rendererID )

2DCGレンダラーを破棄します。

macro paintGraphics2D( int rendererID )

スプライトを合成し、2DCGを描画します。

macro clearGraphics2D( int rendererID )

描画内容を背景色でクリアします。

macro clearGraphics2D( int rendererID, bool removeAll )

描画内容を背景色でクリアし、必要であれば全てのスプライトを配置解除します。

macro setGraphics2DColor( int rendererID, int red, int green, int blue, int alpha )

背景色を設定します。

void setGraphics2DColor( int rendererID, int rgba[ ] )

背景色を設定します。

macro setGraphics2DSize( int rendererID, int width, int height )

描画領域の大きさを設定します。

macro setDrawColor( int rendererID, int red, int green, int blue, int alpha )

描画色を設定します。

void setDrawColor( int rendererID, int rgba[ ] )

描画色を設定します。

void setDrawFont( int rendererID, string name )

テキスト描画に使用するフォントを設定します

void setDrawFontSize( int rendererID, int size )

テキスト描画に使用するフォントのサイズを設定します

void setDrawFontBold( int rendererID, bool isBold )

テキスト描画に使用するフォントを太字に設定または解除します。イタリック体と併用はできません。

void setDrawFontItalic( int rendererID, bool isItalic )

テキスト描画に使用するフォントをイタリック体に設定または解除します。太字と併用はできません。

void drawPoint( int rendererID, int vertex_x, int vertex_y, int radius, bool fill )

点を描画します。

macro drawLine( int rendererID, int vertex_x1, int vertex_y1, int vertex_x2, int vertex_y2 )

直線（線分）を描画します。

macro drawLine( int rendererID, int vertex_x1, int vertex_y1, int vertex_x2, int vertex_y2, int lineWidth )

任意の太さで、直線（線分）を描画します。

macro drawEllipse( int rendererID, int vertex_x, int vertex_y, int width, int height, bool fill )

楕円を描画します。

macro drawRectangle( int rendererID, int vertex_x, int vertex_y, int width, int height, bool fill )

長方形を描画します。

macro drawPolyline( int rendererID, int vertex_x[ ], int vertex_y[ ] )

折れ線を描画します。

macro drawPolyline( int rendererID, int vertex_x[ ], int vertex_y[ ], int lineWidth )

任意の太さで、折れ線を描画します。

macro drawPolygon( int rendererID, int vertex_x[ ], int vertex_y[ ], bool fill )

多角形を描画します。

macro drawPolygon( int rendererID, int vertex_x[ ], int vertex_y[ ], int lineWidth )

任意の太さで、多角形を描画します。

macro drawText( int rendererID, int vertex_x, int vertex_y, string textString )

テキストを1行で描画します。

macro drawText( int rendererID, int vertex_x, int vertex_y, int width, int height, string textString )

テキストを、折り返しながら複数行で描画します。

macro drawImage( int rendererID, int vertex_x, int vertex_y, int graphicsID )

画像を描画します。別の2D/3Dレンダラーの描画結果を、画像として合成的に描画する事もできます。

macro drawImage( int rendererID, int vertex_x, int vertex_y, int width, int height, int graphicsID )

画像をリサイズして描画します。別の2D/3Dレンダラーの描画結果を、画像として合成的に描画する事もできます。

void drawImage( int rendererID, int x, int y, int width, int height, int cropX, int cropY, int cropWidth, int cropHeight, int graphicsID )

画像の一部を抜き出して描画します。別の2D/3Dレンダラーの描画結果を、画像として合成的に描画する事もできます。なお、VCSSL 3.4.8 以前のバージョンにおいては、この関数の挙動はドキュメントの引数の説明と異なっていたため、VCSSL 3.4.10 においてドキュメント通りの挙動に修正されました。VCSSL 3.4.8 以前の挙動を期待したい場合は、この関数の代わりに drawGraphics 関数を使用するよう、呼び出し側のコードの記述を置き換えてください。

macro setPixel( int rendererID, int red[ ][ ], int green[ ][ ], int blue[ ][ ], int alpha[ ][ ] )

描画内容を、ピクセル色成分配列で直接的に設定します。

macro setPixel( int rendererID, int rgba[ ][ ][ ] )

描画内容を、ピクセル色成分配列で直接的に設定します。

void drawPixel( int rendererID, int x, int y, int red[ ][ ], int green[ ][ ], int blue[ ][ ], int alpha[ ][ ] )

現在の描画内容の上に、ピクセル色成分配列の内容を重ねて描画します。

void drawPixel( int rendererID, int x, int y, int rgba[ ][ ][ ] )

現在の描画内容の上に、ピクセル色成分配列の内容を重ねて描画します。

void drawPixel( int rendererID, int x, int y, int width, int height, int red[ ][ ], int green[ ][ ], int blue[ ][ ], int alpha[ ][ ] )

現在の描画内容の上に、ピクセル色成分配列の内容をリサイズした上で、重ねて描画します。

void drawPixel( int rendererID, int x, int y, int width, int height, int rgba[ ][ ][ ] )

現在の描画内容の上に、ピクセル色成分配列の内容をリサイズした上で、重ねて描画します。

void drawPixel( int rendererID, int x, int y, int width, int height, int baseX, int baseY, int baseWidth, int baseHeight, int red[ ][ ], int green[ ][ ], int blue[ ][ ], int alpha[ ][ ] )

現在の描画内容の上に、ピクセル色成分配列の内容から指定領域を抜き出し、重ねて描画します。

void drawPixel( int rendererID, int x, int y, int width, int height, int baseX, int baseY, int baseWidth, int baseHeight, int rgba[ ][ ][ ] )

現在の描画内容の上に、ピクセル色成分配列の内容から指定領域を抜き出し、重ねて描画します。

int[ ][ ][ ] getPixel( int rendererID )

描画領域の保持する内容を、ピクセル色成分配列に変換して返します。

int[ ][ ] getPixelRed( int rendererID )

描画領域の保持する内容を、ピクセルの赤色成分配列に変換して返します。

int[ ][ ] getPixelGreen( int rendererID )

描画領域の保持する内容を、ピクセルの緑色成分配列に変換して返します。

int[ ][ ] getPixelBlue( int rendererID )

描画領域の保持する内容を、ピクセルの青色成分配列に変換して返します。

int[ ][ ] getPixelAlpha( int rendererID )

描画領域の保持する内容を、ピクセルのα値成分配列に変換して返します。

int newPointSprite( int x, int y, int radius, bool fill )

点スプライトを生成し、固有の識別番号（ スプライトID ）を返します。

int newLineSprite( int x1, int y1, int x2, int y2 )

直線（線分）スプライトを生成し、固有の識別番号（ スプライトID ）を返します。

int newEllipseSprite( int x, int y, int width, int height, bool fill )

楕円スプライトを生成し、固有の識別番号（ スプライトID ）を返します。

int newRectangleSprite( int x, int y, int width, int height, bool fill )

長方形スプライトを生成し、固有の識別番号（ スプライトID ）を返します。

int newPolylineSprite( int x[ ], int y[ ] )

折れ線スプライトを生成し、固有の識別番号（ スプライトID ）を返します。

int newPolygonSprite( int x[ ], int y[ ], bool fill )

多角形スプライトを生成し、固有の識別番号（ スプライトID ）を返します。

int newImageSprite( int x, int y, int width, int height, int graphicsID )

画像スプライトを生成し、固有の識別番号（ スプライトID ）を返します。

int newTextSprite( int x, int y, int width, int height, string text )

テキストプライトを生成し、固有の識別番号（ スプライトID ）を返します。

void deleteSprite( int spriteID )

スプライトを破棄します。

void mountSprite( int spriteID, int rendererID )

スプライトを配置します。

void demountSprite( int spriteID, int rendererID )

スプライトを配置解除します。

macro setSpriteDepth( int spriteID, double vertex_z )

スプライトの深度を設定します。スプライトは、深度の値が大きいほど奥に、小さいほど手前に表示されます。

macro setSpriteLocation( int spriteID, int vertex_x, int vertex_y )

スプライトの位置を設定します。

void setSpriteSize( int spriteID, int size )

スプライトの大きさを設定します。この関数は、点スプライトのように、サイズを1個のパラメータで指定できるスプライトに使用します。

macro setSpriteSize( int spriteID, int width, int height )

スプライトの大きさを設定します。

macro setSpriteClip( int spriteID, int clip_x, int clip_y, int clip_width, int clip_height )

スプライトのクリップ情報を設定します。

macro setSpriteColor( int spriteID, int red, int green, int blue, int alpha )

スプライトの色を設定します。

void setSpriteColor( int spriteID, int rgba[ ] )

スプライトの色を設定します。

macro setSpriteFill( int spriteID, bool fillState )

スプライトを塗りつぶすかどうか設定します。

macro setSpriteText( int spriteID, string textString )

スプライトのテキストを設定します。

macro setSpriteImage( int spriteID, int graphicsID )

スプライトの画像を設定します。

void setSpriteFont( int spriteID, string name )

スプライトのテキスト描画に使用するフォントを設定します

void setSpriteFontSize( int spriteID, int size )

スプライトのテキスト描画に使用するフォントのサイズを設定します

void setSpriteFontBold( int spriteID, bool isBold )

スプライトのテキスト描画に使用するフォントを太字に設定または解除します。イタリック体と併用はできません。

void setSpriteFontItalic( int spriteID, bool isItalic )

スプライトのテキスト描画に使用するフォントをイタリック体に設定または解除します。太字と併用はできません。

macro drawOval( int rendererID, int vertex_x, int vertex_y, int width, int height, bool fill )

楕円を描画します。VCSSL 3.3.24 以降では、より新しい drawEllipse 関数がサポートされています。この関数は互換目的でサポートされています。

macro drawRect( int rendererID, int vertex_x, int vertex_y, int width, int height, bool fill )

長方形を描画します。VCSSL 3.3.24 以降では、より新しい drawRectangle 関数がサポートされています。この関数は互換目的でサポートされています。

macro drawGraphics( int rendererID, int vertex_x, int vertex_y, int graphicsID )

別のレンダラーの描画結果や、画像ファイルなどから生成したグラフィックスデータを読み込み、その内容を描画します。VCSSL 3.3.24 以降では、より新しい drawImage 関数がサポートされています。この関数は互換目的でサポートされています。

macro drawGraphics( int rendererID, int vertex_x, int vertex_y, int width, int height, int graphicsID )

別のレンダラーの描画結果や、画像ファイルなどから生成したグラフィックスデータを読み込み、その内容をリサイズして描画します。VCSSL 3.3.24 以降では、より新しい drawImage 関数がサポートされています。この関数は互換目的でサポートされています。

void drawGraphics( int rendererID, int fromLeftTopX, int fromLeftTopY, int fromRightBottomX, int fromRightBottmY, int toLeftTopX, int toLeftTopY, int toRightBottmX, int toRightBottomY, int graphicsID )

別のレンダラーの描画結果や、画像ファイルなどから生成したグラフィックスデータを読み込み、その内容から指定領域を抜き出して描画します。VCSSL 3.3.24 以降では、より新しい drawImage 関数がサポートされています。この関数は互換目的でサポートされています。なお、VCSSL 3.4.8 以前のバージョンにおいては、この関数の挙動と、ドキュメントにおける引数に関する説明が間違っていたため、VCSSL 3.4.10 においてドキュメントの記載内容が修正されました。従って、この関数の挙動そのものは変わっていません。一方で、より新しい drawImage 関数の方は、関数の挙動が（元のドキュメントの記述通りに）修正されました。従って、旧来のプログラムで互換性を優先する場合はこの関数を使用し、新しいプログラムでは drawImage 関数を使用するよう使い分けてください。

int newOvalSprite( int x, int y, int width, int height, bool fill )

楕円スプライトを生成し、固有の識別番号（ スプライトID ）を返します。VCSSL 3.3.24 以降では、より新しい newEllipseSprite 関数がサポートされています。この関数は互換目的でサポートされています。

int newRectSprite( int x, int y, int width, int height, bool fill )

長方形スプライトを生成し、固有の識別番号（ スプライトID ）を返します。VCSSL 3.3.24 以降では、より新しい newRectangleSprite 関数がサポートされています。この関数は互換目的でサポートされています。

int newGraphicsSprite( int x, int y, int width, int height, int graphicsID )

画像スプライトを生成し、固有の識別番号（ スプライトID ）を返します。VCSSL 3.3.24 以降では、より新しい newImageSprite 関数がサポートされています。この関数は互換目的でサポートされています。

void addSprite( int spriteID, int rendererID )

スプライトを配置します。VCSSL 3 以降では、より新しい mountSprite 関数がサポートされています。この関数は互換目的でサポートされています。

void removeSprite( int spriteID, int rendererID )

スプライトを配置解除します。VCSSL 3 以降では、より新しい demountSprite 関数がサポートされています。この関数は互換目的でサポートされています。

macro setSpriteGraphics( int spriteID, int graphicsID )

スプライトのグラフィックスデータを設定します。VCSSL 3.3.24 以降では、より新しい setSpriteImage 関数がサポートされています。この関数は互換目的でサポートされています。

int newLayer()

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

void deleteLayer( int spriteID )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

void mountLayer( int spriteID, int rendererID )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

void addLayer( int spriteID, int rendererID )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

void demountLayer( int spriteID, int rendererID )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

void removeLayer( int spriteID, int rendererID )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

macro setLayerDepth( int spriteID, double vertex_z )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

macro setLayerLocation( int spriteID, int vertex_x, int vertex_y )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

macro setLayerSize( int spriteID, int width, int height )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

macro setLayerClipping( int spriteID, int clip_x, int clip_y, int clip_width, int clip_height )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

macro setLayerColor( int spriteID, int red, int green, int blue, int alpha )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

macro setLayerFill( int spriteID, bool fillState )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

macro setLayerText( int spriteID, string textString )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

macro setLayerGraphics( int spriteID, int graphicsID )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

void setLayerFont( int spriteID, string name )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

void setLayerFontSize( int spriteID, int size )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

void setLayerFontBold( int spriteID, bool b )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

void setLayerFontItalic( int spriteID, bool b )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

int newOvalLayer( int x, int y, int width, int height, bool fill )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

int newRectLayer( int x, int y, int width, int height, bool fill )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

int newLineLayer( int x1, int y1, int x2, int y2 )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

int newPolylineLayer( int x[ ], int y[ ] )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

int newPolygonLayer( int x[ ], int y[ ], bool fill )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

int newGraphicsLayer( int x, int y, int width, int height, int graphicsID )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

int newTextLayer( int x, int y, int width, int height, string text )

この関数の使用は推奨されません。この関数は、互換目的でサポートされています。

構造体 - Structs

- なし - None -

変数 - Variables

- なし - None -

関数 - Functions