DXライブラリ 関数リファレンスページ


 このページではDXライブラリの主な関数の説明と簡単な サンプルプログラムを載せています。


使用必須関数

DxLib_Init ライブラリの初期化
DxLib_End ライブラリ使用の終了関数
ProcessMessage ウインドウズのメッセージを処理する


3D関係関数

一覧はこちら 数が多いので分けました


図形描画関数

DrawLine 線を描画
DrawBox 四角を描画
DrawCircle 円の描画
DrawOval 楕円の描画
DrawTriangle 三角形の描画
DrawPixel 点を描画する
GetPixel 指定点の色を取得


グラフィックデータ制御関数

LoadGraphScreen 画像ファイルを読みこんで画面に表示する
LoadGraph 画像ファイルのメモリへの読みこみ、及び動画ファイルのロード
LoadDivGraph 画像ファイルのメモリへの分割読みこみ
MakeGraph 空のグラフィックを作成する
MakeScreen 描画対象にできるグラフィックを作成する
SetDrawValidMultiSample 描画対象にできるグラフィックのマルチサンプリング設定を行う
SetCreateGraphColorBitDepth 作成するグラフィックのビット深度を設定する
SetDrawValidFloatTypeGraphCreateFlag 描画可能な浮動小数点型のグラフィックを作成するかどうかの設定を行う
SetCreateDrawValidGraphChannelNum 作成する描画可能なグラフィックのチャンネル数の設定を行う
SetUsePremulAlphaConvertLoad 読み込み時に画像を乗算済みα画像に変換するかを設定する
DrawGraph メモリに読みこんだグラフィックの描画
DrawTurnGraph メモリに読みこんだグラフィックのLR反転描画
DrawExtendGraph メモリに読みこんだグラフィックの拡大縮小描画
DrawRotaGraph メモリに読みこんだグラフィックの回転描画
DrawRotaGraph2 メモリに読みこんだグラフィックの回転描画(回転中心指定あり)
DrawRotaGraph3 メモリに読みこんだグラフィックの回転描画(回転中心指定あり、縦横拡大率別指定)
DrawModiGraph メモリに読みこんだグラフィックの自由変形描画
DrawRectGraph グラフィックの指定矩形部分のみを描画
DerivationGraph 指定のグラフィックの指定部分だけを抜き出して新たなグラフィックを作成する
GetDrawScreenGraph 描画先に設定されているグラフィック領域から指定領域のグラフィックを読みこむ
GetGraphSize グラフィックのサイズを得る
InitGraph 読みこんだグラフィックデータをすべて削除する
DeleteGraph 指定のグラフィックをメモリ上から削除する
SetDrawMode 描画モードをセットする
SetDrawBlendMode 描画の際のブレンドモードをセットする
SetDrawBright 描画輝度をセット
SetTransColor グラフィックに設定する透過色をセットする

LoadBlendGraph 画像ファイルからブレンド画像を読み込む
DrawBlendGraph ブレンド画像と通常画像を合成して描画する

GraphFilter 画像にフィルター処理を施す
GraphFilterBlt 画像にフィルター処理を施す( 出力先画像指定版 )
GraphFilterRectBlt 画像にフィルター処理を施す( 出力先画像、使用矩形指定版 )
GraphBlend 二つの画像を特殊効果付きでブレンドする
GraphBlendBlt 二つの画像を特殊効果付きでブレンドする( 出力先画像指定版 )
GraphBlendRectBlt 二つの画像を特殊効果付きでブレンドする( 出力先画像、使用矩形指定版 )


文字描画関係関数

DrawString 文字列を描画する
DrawFormatString 書式付き文字列を描画する
GetDrawStringWidth DrawString で描画される文字列の幅(ドット単位)を得る
GetDrawFormatStringWidth DrawFormatString 関数書式付き文字列の描画幅(ドット単位)を得る
SetFontSize 描画する文字列のサイズをセットする
SetFontThickness 描画する文字列の文字の太さをセットする
ChangeFont 描画するフォントを変更する
ChangeFontType 文字列描画に使用するフォントのタイプを変更する

CreateFontToHandle 新しいフォントデータを作成
DeleteFontToHandle フォントデータを削除する
SetFontCacheUsePremulAlphaFlag 作成するフォントデータを『乗算済みα』用にするかどうかを設定する
DrawStringToHandle 指定のフォントデータで文字列を描画する
DrawFormatStringToHandle 指定のフォントデータで書式付き文字列を描画する
GetDrawStringWidthToHandle 指定のフォントデータで描画する文字列の幅を得る
GetDrawFormatStringWidthToHandle 指定のフォントデータで書式付き文字列の描画幅を得る
GetFontStateToHandle 指定のフォントデータの情報を得る
InitFontToHandle フォントデータを全て初期化する


簡易画面出力関数

printfDx 簡易文字列描画
clsDx 簡易画面出力履歴をクリアする


その他画面操作系関数

SetGraphMode 画面モードの変更
GetScreenState 現在の画面の大きさとカラービット数を得る
SetDrawArea 描画可能領域のセット
ClearDrawScreen 画面に描かれたものを消去する
SetBackgroundColor 画面の背景色を設定する
GetColor 色コードを取得する
SetDrawScreen 描画先グラフィック領域の指定
ScreenFlip フリップ関数、画面の裏ページ(普段は表示されていない)の内容を表ページ(普段表示されている)に反映する
SetFullSceneAntiAliasingMode 画面のフルスクリーンアンチエイリアスモードの設定をする


動画関係関数

PlayMovie 動画ファイルの再生
PlayMovieToGraph ムービーグラフィックの動画の再生を開始する
PauseMovieToGraph ムービーグラフィックの動画再生を一時停止する
SeekMovieToGraph ムービーグラフィックの動画の再生位置を変更する
TellMovieToGraph ムービーグラフィックの動画の再生位置を得る
GetMovieStateToGraph ムービーグラフィックの動画の再生状態を得る


マスク関係関数

CreateMaskScreen マスク画面を作成する
DeleteMaskScreen マスク画面を削除する
LoadMask マスクデータを画像ファイル(BMP.JPEG.PNG)から構築する
LoadDivMask マスクデータを画像ファイル(BMP.JPEG.PNG)から分割構築する
DrawMask マスクデータをマスク画面に描画する
DrawFillMask 指定のマスク画面領域を指定のマスクデータをタイル上に並べて埋める
DeleteMask マスクデータを削除
InitMask マスクデータを初期化する
FillMaskScreen マスク画面を指定の色で塗りつぶす
SetUseMaskScreenFlag マスク画面の有効の有無を変更
MakeMask 空のマスクデータの作成
GetMaskSize マスクデータの大きさを得る
SetDataToMask マスクのデータをマスクデータ領域に転送する
DrawMaskToDirectData マスクのデータをマスク画面に直接描画する
DrawFillMaskToDirectData マスクのデータをタイル上に並べた形で直接マスク画面全体に描画する


入力関係の関数

  ジョイパッド入力関連関数
GetJoypadNum ジョイパッドが接続されている数を取得する
GetJoypadInputState ジョイパッドの入力状態を得る
GetJoypadAnalogInput ジョイパッドのアナログ的なレバー入力情報を得る
GetJoypadDirectInputState ジョイパッドのDirectInputから取得できる情報を得る
GetJoypadXInputState ジョイパッドのXInputから取得できる情報を得る
SetJoypadInputToKeyInput ジョイパッドの入力に対応したキーボードの入力を設定する
StartJoypadVibration ジョイパッドの振動を開始する
StopJoypadVibration ジョイパッドの振動を停止する

  マウス入力関連関数
SetMouseDispFlag マウスカーソルの表示設定フラグのセット
GetMousePoint マウスカーソルの位置を取得する
SetMousePoint マウスカーソルの位置をセットする
GetMouseInput マウスのボタンの状態を得る
GetMouseInputLog マウスのクリック履歴を取得する
GetMouseWheelRotVol マウスホイールの回転量を得る

  キーボード入力関連関数
CheckHitKeyAll すべてのキーの押下状態を取得
CheckHitKey 特定キーの入力状態を得る
GetHitKeyStateAll キーボードのすべてのキーの押下状態を取得する

  半角文字入力関連関数
GetInputChar 文字入力バッファに溜まった文字データから1文字取得する
GetInputCharWait 文字入力バッファに溜まった文字データから1文字取得する、バッファになにも文字コードがない場合はキーが押されるまで待つ
ClearInputCharBuf 文字入力バッファをクリアする

  日本語入力関連関数
KeyInputString キーボードによる文字列の入力
KeyInputSingleCharString キーボードによる半角文字列のみの入力
KeyInputNumber キーボードによる数値の入力
SetKeyInputStringColor KeyInputString系 関数使用時の文字の各色を変更する

MakeKeyInput 新しいキー入力データの作成
DeleteKeyInput キー入力データの削除
InitKeyInput すべてのキー入力データの削除
SetActiveKeyInput 指定のキー入力をアクティブにする
CheckKeyInput 入力が終了しているか取得する
DrawKeyInputString キー入力中データの描画
DrawKeyInputModeString 入力モード文字列を描画する
SetKeyInputString キー入力データに指定の文字列をセットする
SetKeyInputNumber キー入力データに指定の数値を文字に置き換えてセットする
GetKeyInputString 入力データの文字列を取得する
GetKeyInputNumber 入力データの文字列を数値として取得する


音利用関数

PlaySoundFile 音声ファイル(WAV.MP3.Ogg)を再生する
CheckSoundFile 音声ファイルが再生中か調べる
StopSoundFile 音声ファイルの再生を止める
LoadSoundMem 音声ファイル(WAV.MP3.Ogg)をメモリに読みこむ
PlaySoundMem メモリに読みこんだ音声データを再生する
CheckSoundMem メモリに読みこんだ音声データが再生中か調べる
StopSoundMem メモリに読み込んだ音声データの再生を止める
DeleteSoundMem メモリに読みこんだ音声データを削除する
InitSoundMem メモリに読みこんだ音声データをすべて消去する

ChangePanSoundMem メモリに読みこんだ音声データの再生にパンを設定する
ChangeVolumeSoundMem メモリに読みこんだ音声データの再生にボリュームを設定する
ChangeNextPlayPanSoundMem メモリに読みこんだ音声データの次の再生にのみ使用するパンを設定する
ChangeNextPlayVolumeSoundMem メモリに読みこんだ音声データの次の再生にのみ使用するボリュームを設定する
SetFrequencySoundMem メモリに読み込んだ音声データの再生周波数を設定する
SetLoopPosSoundMem メモリに読み込んだ音声データのループ位置を設定する
SetLoopSamplePosSoundMem メモリに読み込んだ音声データのループ位置を設定する(サンプル位置指定)
SetCurrentPositionSoundMem メモリに読み込んだ音声データの再生位置をサンプル単位で変更する
DuplicateSoundMem 既にメモリに読み込んである音声データを使用するサウンドハンドルを新たに作成する( 非ストリームサウンドのみ )

Set3DPositionSoundMem メモリに読み込んだ音声データの3Dサウンド用の再生位置を設定する
Set3DRadiusSoundMem メモリに読み込んだ音声データの3Dサウンド用の音が聞こえる距離を設定する
Set3DVelocitySoundMem メモリに読み込んだ音声データの3Dサウンド用の移動速度を設定する
SetNextPlay3DPositionSoundMem メモリに読み込んだ音声データの次の再生のみに使用する3Dサウンド用の再生位置を設定する
SetNextPlay3DRadiusSoundMem メモリに読み込んだ音声データの次の再生のみに使用する3Dサウンド用の音が聞こえる距離を設定する
SetNextPlay3DVelocitySoundMem メモリに読み込んだ音声データの次の再生のみに使用する3Dサウンド用の移動速度を設定する
Set3DReverbParamSoundMem メモリに読み込んだ音声データの3Dサウンド用のリバーブエフェクトパラメータを設定する
Set3DPresetReverbParamSoundMem メモリに読み込んだ音声データの3Dサウンド用のリバーブエフェクトパラメータをプリセットを使用して設定する
Get3DPresetReverbParamSoundMem 3Dサウンド用のプリセットのリバーブエフェクトパラメータを取得する
Set3DReverbParamSoundMemAll 全てのメモリに読み込んだ音声データの3Dサウンド用のリバーブエフェクトパラメータを設定する
Set3DPresetReverbParamSoundMemAll 全てのメモリに読み込んだ音声データの3Dサウンド用のリバーブエフェクトパラメータをプリセットを使用して設定する

SetCreate3DSoundFlag 次に作成するメモリに読み込む音声データを3Dサウンド用にするかどうかを設定する
Set3DSoundOneMetre 3D空間の1メートルに相当する距離を設定する
Set3DSoundListenerPosAndFrontPos_UpVecY 3Dサウンドのリスナーの位置とリスナーの前方位置を設定する
Set3DSoundListenerPosAndFrontPosAndUpVec 3Dサウンドのリスナーの位置とリスナーの前方位置とリスナーの上方向を設定する
Set3DSoundListenerVelocity 3Dサウンドのリスナーの移動速度を設定する


音楽再生関数

PlayMusic MIDI又はMP3ファイルを演奏(再生)する
CheckMusic MIDI又はMP3ファイルが演奏(再生)中かの情報を取得する
StopMusic MIDI又はMP3ファイルの演奏(再生)停止
SetVolumeMusic MIDI又はMP3ファイルの演奏(再生)の音量を設定する


ウエイト関係の関数

WaitTimer 指定の時間だけ処理をとめる
WaitVSync CRTの垂直同期信号を指定回数待つ
WaitKey キーの入力待ち


時間関係の関数

GetNowCount ミリ秒単位の精度を持つカウンタの現在値を得る
GetNowHiPerformanceCount GetNowCountの高精度バージョン
GetDateTime 現在時刻を取得する


乱数取得関数

GetRand 乱数を取得する
SRand 乱数の初期値を設定する


ウインドウモード関係

ChangeWindowMode ウインドウモード・フルスクリーンモードの変更を行う
SetMainWindowText ウインドウのタイトルを変更する
SetWindowIconID ウインドウのアイコンを変更する
SetWindowSizeChangeEnableFlag ウインドウモードの時にウインドウのサイズを自由に変更出来るようにするかどうかを設定する
SetWindowSizeExtendRate ウインドウモードの時のウインドウの大きさと描画画面の大きさの比率を設定する


通信関係

ConnectNetWork 他のマシンに接続する
CloseNetWork 接続を終了する
PreparationListenNetWork 接続を受け付けられる状態にする
StopListenNetWork 接続を受け付けている状態を解除する
NetWorkSend データを送信する
GetNetWorkDataLength 受信データ一時記憶バッファに溜まっているデータの量を得る
GetNetWorkSendDataLength 未送信のデータの量を得る
NetWorkRecv 受信データ一時記憶バッファに溜まっているデータを取得する
NetWorkRecvToPeek 受信したデータを読み込む、読み込んだデータはバッファから削除されない
GetNewAcceptNetWork 新たに確立した接続を示すネットワークハンドルを得る
GetLostNetWork 新たに破棄された接続を示すネットワークハンドルを得る
GetNetWorkAcceptState 接続状態を取得する
GetNetWorkIP 接続先のIPアドレスを得る

MakeUDPSocket UDPを使用して通信するためのソケットを作成する

DeleteUDPSocket UDPを使用して通信するためのソケットを削除する

NetWorkSendUDP UDPを使用して他のマシンにデータを送信する

NetWorkRecvUDP UDPを使用して他のマシンからのデータを受信する

CheckNetWorkRecvUDP UDPを使用した他のマシンから受信データがあるかどうかを取得する


ファイル読み込み関係

FileRead_open ファイルを開く
FileRead_size ファイルのサイズを得る
FileRead_close ファイルを閉じる
FileRead_tell ファイルポインタの位置を得る
FileRead_seek ファイルポインタの位置を変更する
FileRead_read ファイルからデータを読み込む
FileRead_eof ファイルの終端かどうかを調べる
FileRead_gets ファイルから一行読み出す
FileRead_getc ファイルから一文字読み出す
FileRead_scanf ファイルから書式付きデータを読み出す


ドット単位で画像にアクセスしたい関係

LoadSoftImage CPUで扱うイメージの読み込み
LoadSoftImageToMem CPUで扱うイメージのメモリからの読み込み
MakeARGB8ColorSoftImage CPUで扱うイメージの作成( RGBA8 カラー )
MakeXRGB8ColorSoftImage CPUで扱うイメージの作成( XRGB8 カラー )
MakePAL8ColorSoftImage CPUで扱うイメージの作成( パレット256色 カラー )
DeleteSoftImage CPUで扱うイメージの解放
InitSoftImage CPUで扱うイメージを全て解放
GetSoftImageSize CPUで扱うイメージのサイズを取得する
FillSoftImage CPUで扱うイメージを指定色で塗りつぶす(各色要素は0〜255)
SetPaletteSoftImage CPUで扱うイメージのパレットをセットする(各色要素は0〜255)
GetPaletteSoftImage CPUで扱うイメージのパレットを取得する(各色要素は0〜255)
DrawPixelPalCodeSoftImage CPUで扱うイメージの指定座標にドットを描画する(パレット画像用、有効値は0〜255)
GetPixelPalCodeSoftImage CPUで扱うイメージの指定座標の色コードを取得する(パレット画像用、戻り値は0〜255)
DrawPixelSoftImage CPUで扱うイメージの指定座標にドットを描画する(各色要素は0〜255)
GetPixelSoftImage CPUで扱うイメージの指定座標の色を取得する(各色要素は0〜255)
BltSoftImage CPUで扱うイメージを別のイメージ上に転送する
DrawSoftImage CPUで扱うイメージを画面に描画する
CreateGraphFromSoftImage CPUで扱うイメージからグラフィックハンドルを作成する
CreateDivGraphFromSoftImage CPUで扱うイメージから分割グラフィックハンドルを作成する


非同期読み込み関係

SetUseASyncLoadFlag 非同期読み込みを行うかどうかを設定する
CheckHandleASyncLoad ハンドルが非同期読み込み中かどうかを取得する
GetASyncLoadNum 行っている非同期読み込みの数を取得する


マイナー関数

SetAlwaysRunFlag ウインドウがアクティブではない状態でも処理を続行するか、フラグをセットする
SetOutApplicationLogValidFlag ログ出力を行うか否かのセット

SetUseDXArchiveFlag DXアーカイブファイルの読み込み機能を使うかどうかを設定する
SetDXArchiveExtension 検索するDXアーカイブファイルの拡張子を変更する
SetDXArchiveKeyString DXアーカイブファイルの鍵文字列を設定する

SetEmulation320x240 640x480の画面で320x240の画面解像度にするかどうかのフラグをセットする
SetUse3DFlag 3D機能を使うか、のフラグをセット
SetWaitVSyncFlag ScreenFlip関数実行時にCRTの垂直同期信号待ちをするかのフラグセット
SetUseDivGraphFlag 必要ならグラフィックの分割を行うか否かを設定する
LoadPauseGraph フォーカスが他のソフトに移っているときにバックグラウンドに表示するグラフィックを設定する
ScreenCopy 裏画面の内容を表画面にコピーする
GetColorBitDepth 画面の色ビット数を得る
SaveDrawScreen 現在描画対象になっている画面をBMP形式で保存する
EnumFontName 使用可能なフォントの名前を列挙する
DrawVString 文字列を縦に描画する
DrawVStringToHandle フォントハンドルを使用して文字列を縦に描画する
CreateGraphFromMem メモリ上の画像ファイルイメージからグラフィックハンドルを作成する
ReCreateGraphFromMem メモリ上の画像ファイルイメージから既存のグラフィックハンドルにデータを転送する
ReloadFileGraphAll 画像ファイルから作成したグラフィックハンドルに再度画像ファイルから画像を読み込む
SetRestoreGraphCallback グラフィックハンドル復元関数を登録する

SetCreateSoundDataType 作成する音声データの再生形式を設定する
LoadSoundMemByMemImage メモリ上の音声ファイルイメージからサウンドハンドルを作成する
SetEnableXAudioFlag サウンドの再生にXAudioを使用するかどうかを設定する
SelectMidiMode MIDIの演奏形態をセットする




使用必須関数

宣言int DxLib_Init( void ) ;

概略ライブラリの初期化

引数なし
戻り値 0:成功
 −1:エラー発生

解説  DXライブラリを使用可能な状態に初期化します。
DXライブラリを使用するソフトウェアはまずこの 関数を呼び出す必要があります。
 この関数を使ってもし-1(エラー)が返ってきた場合は直ちに ソフトを終了しなければなりません。

サンプル

  初期化して終了するだけのプログラムです。

#include "DxLib.h"

int WINAPI WinMain( HINSTANCE hInstance, HINSTANCE hPrevInstance,
                         LPSTR lpCmdLine, int nCmdShow )
{
    if( DxLib_Init() == -1 )    // DXライブラリ初期化処理
    {
         return -1;    // エラーが起きたら直ちに終了
    }

    DxLib_End() ;        // DXライブラリ使用の終了処理

    return 0 ;        // ソフトの終了
}



宣言int DxLib_End( void ) ;

概略ライブラリ使用の終了関数

引数なし
戻り値 0:成功
 −1:エラー発生

解説  DXライブラリの使用を終了する関数です。
DXライブラリを使用しているソフトはすべてソフトを 終了させる前にこの関数を呼ぶ必要があります。
 同時に、DXライブラリはソフトのウインドウの制御も しているので、この関数を呼び出した後はなるべくすぐにプログラムを 終了させなければなりません。

サンプル

 すぐ上のDxLib_Init関数のサンプルを参照してください



宣言int ProcessMessage( void ) ;

概略ウインドウのメッセージを処理する

引数なし
戻り値 0:成功
 −1:エラー発生・若しくはウインドウが閉じられた

解説  この関数はWindows環境でのソフトプログラムに付きまとう メッセージループ処理を肩代わりしてくれる関数です。
 この関数がなにをしているのか、というのは特に気にする 必要はありませんが、とにかく定期的にこの関数を呼び出して やる必要があります。
 目安としては60分の1秒に一回程度、用はゲームのループに 一回程度です。この関数を呼び出さないと結果としてシステムが 異常に重くなったり不安定になったりします。
 あと、戻り値が-1( エラー発生・若しくはDXライブラリのウインドウが閉じられた )になったらなるべく早めにDxLib_Endでライブラリ使用を終了し、同時にプログラムも終了する必要があります。( そうしないとウインドウを閉じてもプロセスが残るという事態になります )

サンプル

 キーが押されるまで待つループの中にProcessMessageを入れています。

#include "DxLib.h"

int WINAPI WinMain( HINSTANCE hInstance, HINSTANCE hPrevInstance,
                         LPSTR lpCmdLine, int nCmdShow )
{
    // DXライブラリ初期化処理
    if( DxLib_Init() == -1 )
    {
         return -1;        // エラーが起きたら直ちに終了
    }

    // キーが押されるまでループします
    // (因みにキーが押されるまで待つ事は『WaitKey』という
    //  専用の関数があります)
    while( CheckHitKeyAll() == 0 )
    {
        // メッセージループに代わる処理をする
        if( ProcessMessage() == -1 )
        {
            break ;        // エラーが起きたらループを抜ける

        }
    }

    // DXライブラリ使用の終了処理
    DxLib_End() ;

    return 0 ;            // ソフトの終了
}







戻る