このドキュメントはRuby/SDLのリファレンスマニュアルです。 Ruby/SDLの各機能、各クラス、各メソッドを解説しています。
このリファレンスは <URL:http://www.tacoworks.jp/software/SDLdoc-jp/index-j.html> におけるSDLdoc日本語翻訳プロジェクトの成果を利用しています。 プロジェクトのみなさんに感謝します。
Ruby/SDL は SDL を Ruby から利用するための 拡張ライブラリです。 Ruby でゲームなどを使うためなどに利用できます。
Ruby/SDLは、以下の機能を持っています。
Ruby 1.9では、Stringにエンコーディング情報が付いて いますが、Ruby/SDLでは基本的にこの情報を無視します。 SDLでこのような情報をどうすべきか定義されていないためです。
ただしいくつかのメソッドではRuby 1.9においては エンコーディンの利用および付加を行います。 詳しくは各メソッドの項を見てください。
extconf.rbを実行するときに--enable-m17n/--disable-m17n オプションを使うことで、これらのRuby/SDLの m17n関連の機能を有効/無効にできます。
SDL固有のエラーを表わす例外クラスです。StandardErrorを継承しています。
SDLのバージョンを表わす文字列です。"1.0.0"という形になっています。
Ruby/SDLを使う前には必ずSDL.initで初期化する必要があります。SDL.initは、 ユーザの指定したすべてのサブシステム(ビデオ、オーディオ、ジョイスティック、 タイマー、CD-ROMのいずれかあるいは全部)を初期化することができます。
SDL.init(flags)SDLを初期化します。 すべてのRuby/SDLのメソッドを呼び出す前にこの関数が呼ばれなければいけません。 flagsにはSDLのどの部分を初期化するかを指定します。
失敗すると例外SDL::Errorが発生します。
SDL.quit全てのSDLサブシステムをシャットダウンし、それらが確保したリソースをすべて解 放します。通常は自動で呼ばれるためユーザが明示的に呼びだす必要はありません。
SDLおよびRuby/SDLの仕様を理解した上で必要な場合のみ使ってください。
SDL.inited_system(flags)SDL.initedSystem(flags)これは、どのSDLサブシステムが初期化されているかを報告します。 flagsには、調べたいサブシステムの論理和を指定します (指定できるサブシステムのフラグについてはSDL.initの項を参照してください)。
初期化されているサブシステムの論理和を返します。
EXAMPLE
# SDL.inited_systemの使いかた # 全てのサブシステムの初期化状態を得ます subsystem_init = SDL.inited_system(SDL::INIT_EVERYTHING) if subsystem_init & SDL::INIT_VIDEO puts "ビデオは初期化されています。" else puts "ビデオは初期化されていません。" end # 1つのサブシステムだけをチェックします if SDL.inited_system(SDL::INIT_VIDEO) != 0 puts "ビデオは初期化されています。" else puts "ビデオは初期化されていません。" end # 2つのサブシステムをチェックします subsystem_mask = SDL::INIT_VIDEO|SDL::INIT_AUDIO; if SDL.inited_system(subsystem_mask) == subsystem_mask puts "ビデオとオーディオはどちらも初期化されています。" else puts "ビデオとオーディオのどちらか、または両方が初期化されていません。" end
See Also
SDL.getenv(var)varで指定した環境変数を得ます。
環境変数の値を文字列で返します。
SDL.putenv(string)環境変数の追加または値の変更を行います。string は "name=value" という形式を取ります。
Windows上でSDL_WINDOWIDやSDL_VIDEODRIVERといった環境変数を使って SDLの実行に影響を与えたいときに利用します。 SDLの仕様によりWindowsでは ENV を直接変更してもこれらの機能が使え ないためこのような関数が存在しま。Unix上では ENV を使うのと同じ 効果があります。
失敗時には例外SDL::Errorを発生させます。
EXAMPLE
# http://moriq.tdiary.net/20051006.html より
# Ruby/SDL と Apolloの併用
require 'phi'
require 'sdl'
# フォームの生成
form = Phi::Form.new
$terminated = false
form.on_close{ $terminated = true }
form.caption = "Ruby/SDL on Phi::Form"
# パネルをフォームの上に作る
panel = Phi::Panel.new(form)
panel.align = Phi::AL_LEFT
# WINDOWID hackを使い、パネルにSDLのウインドウをのせる
SDL.putenv("SDL_VIDEODRIVER=windib")
SDL.putenv("SDL_WINDOWID=#{panel.handle}")
form.show
# SDL本体の初期化など
SDL.init(SDL::INIT_VIDEO)
screen = SDL.setVideoMode(640, 480, 16, SDL::SWSURFACE)
# メインループ、とりあえず何もしない
unless $terminated
while event = SDL::Event.poll
case event
when SDL::Event::KeyDown, SDL::Event::Quit
exit
end
end
sleep 0.05
endSDL は表示フレームバッファに対するとてもシンプルなインターフェースを 提供します。 フレームバッファはあなたが直接書くことができる オフスクリーンサーフェスとして表現されます。 スクリーンに書いたものを画面に表示させるには、 画面の必要な部分が更新されることを保証する 更新関数を呼んで下さい。
Ruby/SDL のいかなるビデオ関連メソッドを呼ぶ前に、 最初に SDL.init(SDL::INIT_VIDEO)を呼ばなければいけません。 これは SDL 内のビデオとイベントを初期化します。
アプリケーションでサウンドとビデオを共に使うときは、 サウンドデバイスをオープンする前に SDL.init(SDL::INIT_AUDIO|SDL::INIT_VIDEO) を呼ぶ必要があります。 そうしないと、Win32 の DirectX において フルスクリーン表示モードにセットすることができないでしょう。
ライブラリを初期化した後は、ビデオ表示を順番にスタートさせることができます。 最も簡単な方法は、共通のスクリーン解像度とピクセル深度を選び、 エラーをチェックしつつビデオを初期化することです。 おそらくあなたが望んだものが得られるでしょうが、 SDL はあなたが求めたモードをエミュレートし、 更新の際に変換しているかもしれません。 最もよい方法は、 望まれるものに最も近いビデオモードを 問い合わせ、 そのピクセルフォーマットに合わせて画像を 変換することです。
SDL は現在 1 ピクセル 8 bit 以上のいかなるピクセル深度もサポートしています。 8 bpp のフォーマットは 8 bit のパレットモードとしてみなされ、 12, 15, 16, 24, そして 32 bpp は 「パックドピクセル」モードとしてみなされます。 これは、個々のピクセルが RGB 各チャンネルの輝度を ピクセルのビットの中にパッキングして持っているということです。
ビデオモードを初期化した後は、 返値として得られたサーフェスに対し、他のフレームバッファのように書き込み、 いつものように更新処理を呼ぶことができます。
Ruby/SDLでゲームを作る場合を考えると、性能上のボトルネックとなるのは 描画部分が主になります。そこで、この部分を高速化することで 全体を高速化することができます。以下に描画を高速化するための こつをいくつか書いておきます。
SDL::Surface#display_formatを使う
あらかじめこのメソッドを呼んでおいて高速描画可能なフォーマット に変更しておくと、劇的に高速化します。
アルファブレンドはできるかぎり使わない
非常に遅いです。
描画には SDL::Surface.blit, SDL::Surface#put, SDL::Surface#fill_rect のみを 使う。
まともに高速化されているのは以上の描画メソッドのみです。
回転や拡大縮小は描画時にせず、初期化時にそのようなSDL::Surfaceを あらかじめ準備しておく
回転や拡大縮小描画は上の項に書いた通り遅いので、性能が必要な 場合にはあらかじめ回転拡大縮小して、SDL::Surface#display_format で高速な形式に変換しておいて、それを使うべきです。
また、アルファブレンドや回転や拡大縮小を高速に行いたいので あれば、Video subsystem を使わずに OpenGL を使うという方法 もあります。高速なビデオカードとドライバを 用意できるのであれば Video subsystem を使うより 高速な描画が可能となるでしょう。
絵のサーフェスを表わすクラスです。
このクラスは描画される「画像」のメモリを表現しています。
メソッドおよびクラスメソッドのリスト
画面に対応するサーフェスを表わすクラスです。
このクラスは SDL::Surface のサブクラスであり、実際に画面に表示される サーフェスを表わします。
ビデオフレームバッファは SDL::Screen.open と SDL::Screen.get から得られます。
メソッドおよびクラスメソッドのリスト
ビデオターゲットの情報を表わすクラスです。 このクラスのインスタンスは SDL::Screen.info から返り値として得られます。 これは以下のメソッドを持ちます。
SDL::VideoInfo#hw_availableSDL::VideoInfo#wm_availableSDL::VideoInfo#blit_hwSDL::VideoInfo#blit_hw_CCSDL::VideoInfo#blit_hw_ASDL::VideoInfo#blit_swSDL::VideoInfo#blit_sw_CCSDL::VideoInfo#blit_sw_ASDL::VideoInfo#blit_fillSDL::VideoInfo#video_memSDL::VideoInfo#bppサーフェスのフォーマットを表すクラスです。 詳しくは色、ピクセルフォーマット、ピクセル値について をみてください。
メソッドおよびクラスメソッドのリスト
まずは Ruby/SDL において重要なことを先に書きます。 Ruby/SDLにおいて色はRGBAそれぞれ0から255までの値を取ります。 性能のため SDL 内部ではRGBA値を32ビット符号無し整数でパッキングします。 このRGBA値と符号無し32ビット整数との変換規則をピクセルフォーマットと 呼び、変換後の値をピクセル値と呼びます。 ピクセルフォーマットはサーフェスごとに決まっていて、 変換はSDL::PixelFormat#map_rgb、SDL::PixelFormat#map_rgba、 SDL::PixelFormat#get_rgb、SDL::PixelFormat#get_rgbaというメソッドでします。 メソッドの引数などで色を指定する場合、[231, 251, 100] というような 要素が3個の配列(RGB,A=255)、 [231, 251, 100, 128]という要素が4個の配列(RGBA)、もしくはピクセル値の いずれでも使えます。またメソッドの返り値として色情報が得られる場合は 通常ピクセル値が得られます。
以下はより基本的でより詳しい内容です。
Ruby/SDLにおける絵は、ピクセルの集合として表されます。 ピクセルと呼ばれる小さな正方形を縦横に並べ、そのそれぞれに 色をわりあてることで画像を表現します。 例えば 640x480 の絵は 307200個 = 640×480 のピクセルで表わされます。
そして、その色は光の3原色である赤(Red)、緑(Green)、青(Blue)それぞれの値 を0から255までで指定することで決めます。例えば [R,G,B] = [0,0,0] ならば黒、 [255, 255, 0]ならば黄色、[160, 32, 240]で紫、などです。
そしてこの情報をバイト列に変換して保存します。一つのピクセルに対し 8ビット、16ビット、24ビット、もしくは32ビットのメモリを割当て、 R,G,Bの 255*255*255の情報を適当にそのメモリに収まるように変換します。 このビット数をbpp(Bits Per Pixel)と呼びます。 そしてこの色の情報 -> バイト列の変換規則をピクセルフォーマットと呼びます。 また、ピクセル1個分の色データをピクセルフォーマットで変換したものを ピクセル値と呼びます。性能のため SDL 内部ではこのピクセル値を よく利用します。 それぞれのサーフェスは、このピクセルフォーマットと「絵を表わすバイト列」 の組であると解釈できます。
この色データとピクセル値の相互変換は SDL::PixelFormat#map_rgb、SDL::PixelFormat#get_rgbというメソッドでします。
また、各メソッドの引数で色を指定する場合は、[r, g, b]という要素が整数3個の 配列、もしくはそのサーフェスのピクセルフォーマットで変換したピクセル値の どちらでも使える場合がほとんどです。
最後にα値について解説します。この値はある画像と別の画像を重ね合わせる 時に意味のある値です。SDL::Surface.blitなどで2つの画像が重ね合わされる場合、 通常下の画像は上の画像で完全に隠されてしまいます。しかし上の画像に α値を指定しておくと、上の画像の色と下の画像の色が混ぜ合されます。 この混ぜ合せの割合をα値と呼びます。SDLではα値は0から255までの値をとりえます。 0が完全な透明で、255が完全な不透明です。 この値はbppが32の場合には、各ピクセルごとに指定することができます。 つまりピクセル値には R,G,B のほかアルファ(Alpha)値を含めることができると いうことです。このα値を含めた変換には SDL::PixelFormat#map_rgba、[PixelFormat#get_rgba]を使います。 また各メソッドの引数でアルファ付きの色を指定する場合は、[r,g,b,a]という 要素が整数4個の配列を使うことが可能です。
SDL.get_video_surfaceSDL.getVideoSurfaceSDL::Screen.getこのメソッドは現在の表示サーフェスを返します。 SDL が表示サーフェス上でフォーマット変換を行っている場合は、 この関数は実際のビデオサーフェスではなく、(SDL を使う側に 見せている) 変換前のサーフェスを返します。
SDL::Screenのインスタンスを返します。
失敗したときには例外SDL::Errorを発生させます。
SDL.video_infoSDL.videoInfoSDL::Screen.infoこの関数はビデオハードウェアに関する情報を返します。
SDL::Screen.openの前にこれが呼ばれると、 返されたオブジェクトのbppアトリビュートには 「最も適した」ビデオモードのピクセルフォーマットが入ります。
情報をSDL::VideoInfoのインスタンスで返します。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL.video_driver_nameSDL.videoDriverNameSDL::Screen.driver_nameSDL::Screen.driverNameドライバ名は "x11" や "windib" のように単なる 1 語の識別子です。
ドライバ名を文字列で返します。
ビデオがまだSDL.initで初期化されていないなら例外SDL::Errorを発生させます。
See Also
SDL.list_modes(flags)SDL.listModes(flags)SDL::Screen.list_modes(flags)SDL::Screen.listModes(flags)与えられたビデオのフラグに対し、 利用可能な画面モードの配列を返します。
フラグはSDL::Screen.open で使われるものと同じであり、モードが有効かどうかを決定する際に 強い役割を果たします。 SDL::HWSURFACEをフラグとして渡すと、 ハードウェアのビデオサーフェスがサポートするモードだけが返されます。
大きい方から小さい方にソートされています。 ある特定のフォーマットに対し利用可能なモードがない場合は nil を返し、 与えられたフォーマットに対しどのモードでも OK の場合は true を返します。 利用可能なモードが有限個しか存在しない場合は、 [縦方向の解像度, 横方向の解像度]という配列の配列を返します。
EXAMPLE
# 利用可能なフルスクリーンハードウェアモードを取得する
modes = SDL::Screen.list_modes(SDL::FULLSCREEN|SDL::HWSURFACE)
# 利用可能なモードがあるかどうかチェック
if modes == nil
puts "利用可能なモードがありません!"
exit 1
end
# 解像度が制限されているかどうかチェック
if modes == true
puts "全解像度が利用可能です。"
else
# 有効なモードを表示
puts "利用可能なモード"
modes.each{|w, h| puts " #{w} x #{h}"}
end
See Also
SDL.check_video_mode(w,h,bpp,flags)SDL.checkVideoMode(w,h,bpp,flags)SDL::Screen.check_mode(w,h,bpp,flags)SDL::Screen.checkMode(w,h,bpp,flags)要求されたモードがどのピクセル深度においてもサポートされていない場合は 0を返し、 あるいは与えられた横幅・高さと 要求されたサーフェス フラグ(SDL::Screen.openを見て下さい) において利用可能な最も近いピクセル深度を返します。
ピクセル深度の値は推奨されるモードに過ぎません。 ビデオモードの設定時に 普通にあなたの望むピクセル深度を要求することができ、 SDL はシャドウビデオサーフェスを使ってそのピクセル深度を エミュレートするでしょう。
EXAMPLE
puts "640x480@16bpp のモードをチェックしています。"
bpp = SDL::Screen.check_mode(640, 480, 16, SDL::HWSURFACE)
if bpp == 0
puts "利用可能なモードではありません。"
exit 1
end
puts "SDL は 640x480@#{bpp}bpp を推奨します。"
screen = SDL::Screen.open(640, 480, bpp, SDL_HWSURFACE)
See Also
SDL.setVideoMode(w,h,bpp,flags)SDL.set_video_mode(w,h,bpp,flags)SDL::Screen.open(w,h,bpp,flags)指定された幅・高さ・ピクセル深度(1ピクセルのビット数)を用いて ビデオモードを設定します。 bpp が 0 ならば、現在表示されているピクセル深度として扱われます。
flags パラメータはSDL::Surface#flagsと同じです。 以下の値の OR による組み合わせが有効です。
フレームバッファのサーフェスをSDL::Screenのインスタンスで返します。
失敗したときには例外SDL::Errorを発生させます。
NOTES
このメソッドがどのflagsをを満たすことができたかは、 返り値のサーフェスのSDL::Surface#flagsにセットされています。
bpp パラメータはピクセルごとのビット数です。 そのため、bpp が 24 の場合は 3 バイト/ピクセルの パッキングされた表現方法が使われます。 より一般的な 4 バイト/ピクセルのモードについては、 bpp が 32 の場合に使われます。 幾分奇妙ですが、15 と 16 の場合はいずれも 2 バイト/ピクセルのモードを 要求しますが、異なるピクセルフォーマットです。
See Also
SDL::Surface#lock, SDL::Surface#set_colors, SDL::Screen#flip, SDL::Screen
SDL::Screen#updateRect(x,y,w,h)SDL::Screen#update_rect(x,y,w,h)与えられた領域の画面を更新します。 矩形は画面の境界内の収まっていなければなりません。 (つまりクリッピングはされません)
x、y、w、hがすべて 0 ならば、画面全体を更新します。
このメソッドはselfがロックされている間は呼んでは いけません。
See Also
SDL::Screen#update_rects(*rects)SDL::Screen#updateRects(*rects)与えられた矩形の配列に従い、画面を更新します。 個々の矩形は[x, y, w, h]という配列で指定します。 矩形は画面の境界内の収まっていなければなりません。 (つまりクリッピングはされません)
このメソッドはselfがロックされている間は呼んでは いけません。
See Also
SDL::Screen#flipダブルバッファをサポートするハードウェアにおいて、 この関数は切替を設定して帰ってします。 ハードウェアは垂直帰線区間を待ち、 次のビデオサーフェスの blit 転送やロックが戻る前に ビデオバッファを交換します。 ダブルバッファをサポートしないハードウェアにおいては、 self.update_rect(0, 0, 0, 0) を呼ぶのと同等です。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::Surface#set_colors(colors,firstcolor)SDL::Surface#setColors(colors,firstcolor)self が現在の表示と関連付けられたサーフェスの場合は、 表示カラーマップは要求された色で更新されます。SDL::Screen.open フラグに SDL::HWPALETTE がセットされていた場合は、 SDL::Surface#set_colors は常にtrueを返し、 ウィンドウのカラーマップが歪められていたり、 エミュレーションの下で動いている場合でも、 パレットはあなたが望んだ通りにセットされることが保証されています。
colorsとして色情報の配列を与える必要があります。色情報とは R、G、Bそれぞれ0から255までの値を持つ要素が3個の配列です。
SDL::HWPALETTE がセットされた、パレット化された(8 bit) 画面サーフェスには 2 種類のパレット、すなわち サーフェスに対する(あるいはサーフェスからの)マッピング blit に 使われる論理パレットと、 ハードウェアが色を画面にどうマッピングするかを決定する物理パレット とがあります。 SDL::Surface#SDL_set_colors は(存在するなら)双方のパレットを変更します。 これは (SDL::LOGPAL | SDL::PHYSPAL) を flags にセットして SDL::Surface#set_palette を呼ぶのと同等です。
self がパレット化されたサーフェスではない場合は、 このメソッドは何もせず、false を返します。 全ての色がこのメソッドに 渡した通りにセットされた場合は、true を返します。 必ずしも全ての色エントリが与えられた通りにセットされた訳ではない場合は、 false を返すので、 実際の色パレットを決めるサーフェスパレットを見る必要があります。
EXAMPLE
# グレースケールのパレットでサーフェスを作成
# 色情報で埋める
colors = Array.new(256){|i| [i, i, i]}
# 表示サーフェスを作成
screen = SDL::Screen.open(640, 480, 8, SDL::HWPALETTE)
# パレットのセット
screen.set_colors(colors, 0)
See Also
SDL::Surface#set_palette, SDL::Screen#open
SDL::Surface#set_palette(flags,colors,firstcolor)SDL::Surface#setPalette(flags,colors,firstcolor)与えられた 8 ビットサーフェスに対し、パレットの一部をセットします。
SDL::HWPALETTE フラグがセットされている パレット(8ビット) の画面サーフェスには 2種類のパレットがあります。 すなわち、サーフェスからの(あるいはサーフェスに対する) blit 転送を マッピングする論理パレットと、 ハードウェアが色を画面にマッピングする方法を決定する 物理パレットです。 SDL::Surface.blit は サーフェスのピクセルフォーマット間で変換が必要な場合、 サーフェスを blit 転送する際に常に論理パレットを使います。 このため、さまざまな特殊色効果 (画面のフェード・カラーフラッシュ・画面の霞み)を得るために パレットを片方だけ変更することはしばしば有用です。
このメソッドは SDL::LOGPAL か SDL::PHYSPAL を flags に指定することで、 論理または物理パレットのいずれかを変更することができます。 selfが現在の表示と 関連付けられているサーフェスのときは、 表示のカラーマップは要求された色で更新されます。 SDL::Screen.open に SDL::HWPALETTE がセットされていた場合は、 このメソッドは常に true を返し、 ウィンドウのカラーマップが歪められなければならない場合や、 エミュレーション下で動いている場合であっても、 パレットにはあなたが望んだ方法でセットされることが保証されます。
colorsとして色情報の配列を与えます。色情報とは R、G、Bそれぞれ0から255までの値を持つ要素が3個の配列です。 256**3 = 16777216色が使えます。
selfがパレット化されたサーフェスでない場合は、 このメソッドは false を返して何もしません。 全ての色がこのメソッドに渡された通りにセットされると、 true を返します。 必ずしも全ての色エントリが与えられた通りにセットされた訳ではない場合は、 false を返すので、 実際の色パレットを決定するサーフェスパレットを見る必要があります。
EXAMPLE
# グレースケールのパレットでサーフェスを作成
# 色情報で埋める
colors = Array.new(256){|i| [i, i, i]}
# 表示サーフェスを作成
screen = SDL::Screen.open(640, 480, 8, SDL::HWPALETTE)
# パレットのセット
screen.set_palette(SDL::LOGPAL|SDL::PHYSPAL, colors, 0)
See Also
SDL.set_gamma(redgamma,greengamma,bluegamma)SDL.setGamma(redgamma,greengamma,bluegamma)SDL::Screen.set_gamma(redgamma,greengamma,bluegamma)SDL::Screen.setGamma(redgamma,greengamma,bluegamma)各カラーチャンネルについて、表示用の「ガンマ関数」をセットします。 ガンマは画面に表示される色の明るさ・コントラストを制御します。 ガンマ値 1.0 は単位元です。 (つまり、何の調整も行われません)
この関数は「ガンマ関数」のパラメータに基いてガンマを調整します。 SDL::Screen.set_gamma_ramp を使うと、 ガンマ調整の参照テーブルを直接指定することができます。
失敗したときには例外SDL::Errorを発生させます。
NOTES
全ての表示ハードウェアがガンマを変更することができるわけではありません。
See Also
SDL.get_gamma_rampSDL.getGammaRampSDL::Screen.get_gamma_rampSDL::Screen.getGammaRamp現在表示に使われているガンマ値の変換テーブルを取得します。 それぞれのテーブル(R, G, B)は 256 個の16bit符号なし整数値の配列です。
3個の「256個の16bit符号なし整数値の配列」の配列を返します。
失敗したときには例外SDL::Errorを発生させます。
NOTES
全ての表示ハードウェアがガンマを変換できるわけではありません。
See Also
SDL.set_gamma_ramp(table)SDL.setGammaRamp(table)SDL::Screen.set_gamma_ramp(table)SDL::Screen.setGammaRamp(table)各色チャンネルについて、表示用のガンマ参照テーブルをセットします。 引数 tables は SDL::Screen.get_gamma_ramp と同じフォーマットで、 対応するチャンネルの入力と出力間の写像を表現します。 入力は配列に対するインデックスであり、出力はそのインデックスにおける 16 ビットのガンマ値で、出力の色精度に合わせてスケーリングされます。
この関数は参照テーブルに基いてガンマを調整しますが、 SDL::Screen.set_gamma を用いて 「ガンマ関数」パラメータに基いて計算されたガンマも持つことができます。
失敗したときには例外SDL::Errorを発生させます。
SDL::Surface#map_rgb(r,g,b)SDL::Surface#mapRGB(r,g,b)SDL::PixelFormat#map_rgb(r,g,b)SDL::PixelFormat#mapRGB(r,g,b)RGB カラーの値をselfのピクセルフォーマットに写像し、 ピクセル値を 32bit 符号無し整数 として返します。 r、g、b は0から255までの値をとれます。
フォーマットがパレット (8ビット) を持つ場合は、 パレット内において最も近い色のインデックスが返されます。
指定されたピクセルフォーマットがαチャンネルを持つ場合は、 全て 1 のビット(完全に不透明)として返されます。
与えられたピクセルフォーマット上において、 与えられた RGB カラー値を最も良く近似するピクセル値です。 ピクセルフォーマットのピクセル深度が 32bpp より小さい場合は、 返値の使用されていない上位ビットは安全に無視することができます。 (例えば、16bpp のフォーマットでは返値は 2**16 より小さく、 8bpp では 2**8 より小さい)
SDL::Surface#map_rgba(r,g,b,a)SDL::Surface#mapRGBA(r,g,b,a)SDL::PixelFormat#map_rgba(r,g,b,a)SDL::PixelFormat#mapRGBA(r,g,b,a)RGBA カラーの値をselfのピクセルフォーマットに写像し、 ピクセル値を 32bit 符号無し整数 として返します。 r、g、b、a は0から255までの値をとれます。
フォーマットがパレット (8ビット) を持つ場合は、 パレット内において最も近い色のインデックスが返されます。
指定されたピクセルフォーマットがαチャンネルを持たない場合は、 (パレットを持つフォーマットの中でそうであるように) α値は無視されます。
与えられたピクセルフォーマット上において、 与えられた RGBA カラー値を最も良く近似するピクセル値です。 ピクセルフォーマットのピクセル深度が 32bpp より小さい場合は、 返値の使用されていない上位ビットは安全に無視することができます。 (例えば、16bpp のフォーマットでは返値は 2**16 より小さく、 8bpp では 2**8 より小さい)
SDL::Surface#get_rgb(pixel)SDL::Surface#getRGB(pixel)SDL::PixelFormat#get_rgb(pixel)SDL::PixelFormat#getRGB(pixel)selfのピクセルフォーマットによるピクセル値から RGB 各チャンネルの値を要素数3の配列で取得します。
このメソッドは RGB 各チャンネルが 8 ビット未満のピクセルフォーマットから 色チャンネルを変換する際にも 8 ビット全体 [0〜255] の範囲を使います。 (例えば、16 ビット RGB565 フォーマットにおける完全な白色は [0xf8, 0xfc, 0xf8] ではなく [0xff, 0xff, 0xff] を返します)
SDL::Surface#get_rgba(pixel)SDL::Surface#getRGBA(pixel)SDL::PixelFormat#get_rgba(pixel)SDL::PixelFormat#getRGBA(pixel)指定されたピクセルフォーマットに格納されたピクセルから RGBA 各チャンネルの値を要素数4の配列で取得します。
RGB 各チャンネルが 8 ビット未満のピクセルフォーマットから 色チャンネルを変換する際にも 8 ビット全体 [0〜255] の範囲を使います。 (例えば、16 ビット RGB565 フォーマットにおける完全な白色は [0xf8, 0xfc, 0xf8] ではなく [0xff, 0xff, 0xff] を返します)
サーフェスにαチャンネルがない場合は、αには 0xff (100% 不透明) が返されます。
SDL::Surface.new(flags,w,h,depth,Rmask,Gmask,Bmask,Amask)SDL::Surface.new(flags,w,h,format)大きさが w x h の空のサーフェスを確保します。 (SDL::Screen.openの後で呼ばれなければいけません)
depth が 8 ビットの場合は、 サーフェスに空のパレットが確保されます。 そうでない場合は、 与えられたRmask、Gmask、Bmask、Amask を使って 「パッキングされたピクセル」が作られます。 flags は作られるサーフェスのタイプを指定し、 以下の取りうる値の OR による組み合わせとなります。
また、depth,Rmask,Gmask,Bmask,Amaskの代わりに SDL::PixelFormat のインスタンス を渡すとこれらの値が与えたインスタンスと同じになります。
SDL::Surfaceのインスタンスを返します。
失敗したときには例外SDL::Errorを発生させます。
EXAMPLE
# テクスチャ用として OpenGL に要求される、
# 個々々のピクセルのバイトが RGBA の順番で並んだ
# 32 ビットのサーフェスを生成
big_endian = ([1].pack("N") == [1].pack("L"))
if big_endian
rmask = 0xff000000
gmask = 0x00ff0000
bmask = 0x0000ff00
amask = 0x000000ff
else
rmask = 0x000000ff
gmask = 0x0000ff00
bmask = 0x00ff0000
amask = 0xff000000
end
surface = SDL::Surface.new(SDL::SWSURFACE, width, height, 32,
rmask, gmask, bmask, amask);
NOTES
αチャンネルが指定されている (つまり Amask が 0 でない) 場合は、 SDL::SRCALPHA フラグは自動的にセットされます。 サーフェスを作った後は、SDL::Surface#set_alphaを 呼ぶことでこのフラグを取り除くことができます。
See Also
SDL::Surface.new_from, SDL::Screen.oepn, SDL::Surface#lock, SDL::Surface#set_alpha, SDL::Surface#set_color_key
SDL::Surface.new_from(pixels,w,h,depth,pitch,Rmask,Gmask,Bmask,Amask)与えられたピクセルデータ(pixels、 Stringのインスタンス)から SDL::Surface のインスタンスを生成します。 pixels に格納されたデータは depth のものであるとみなされます。 pitch は各スキャンラインの長さ(バイト数)です。
他のパラメータについての詳しい記述については、SDL::Surface.newを見てください。
生成されたサーフェスを返します。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::Surface#lockピクセルに直接アクセスするためにサーフェスをロックします。 SDL::Surface#lock と SDL::Surface#unlock の呼びだしの間、 サーフェスへ直接読み書きができます。 ひとたびサーフェスへのアクセスが終了したら、 SDL::Surface#unlock を使って解放する必要があります。
サーフェスへ直接読み書きをする、ロックが必要なメソッドは 以下の通りです。
またSDL.auto_lock?が真である場合には、ロックが必要なメソッドが呼ばれた 場合自動的にロックの設定と解放をするため、このメソッドを呼ぶ必要 はありません。
すべてのサーフェスがロックを必要とする訳ではありません。 SDL::Surface#must_lock?が偽ならば いつでも読み書きすることができ、サーフェスのピクセルフォーマット は変更されません。
この時間の間にクリティカルなシステムロックが行われることがあるため、 ロック/アンロック間では、いかなる OS システムコールやライブラリコールも 呼ばれるべきではありません。
明記しておくべきことに、 SDL 1.1.8 以降ではサーフェスのロックは再帰的である、という点があります。 これは複数のサーフェスロックをかけることができるということですが、 個々のロックには対応するアンロックがなければいけません。
surface.lock # サーフェスはロックされている # ここでサーフェス上の直接ピクセルアクセス surface.lock # さらにサーフェス上の直接ピクセルアクセス surface.unlock # サーフェスはまだロックされている # 注記: バージョンが 1.1.8 以下の場合は、 # この段階でサーフェスはもうロックされていない surface.unlock # サーフェスは今アンロックされている
サーフェスのロックができなかった場合は例外SDL::Errorを返します。
SDL::Surface#unlockSDL::Surface#lockを使ってロックされたサーフェスは このメソッドでロックを解除しなければいけません。 サーフェスのロックはできるだけ早く解除されるべきです。
1.1.8 以降、サーフェスのロックは再帰的であることに注意すべきです。
See Also
SDL::Surface#must_lock?SDL::Surface#mustLock?See Also
SDL::Surface.load_bmp(filename)SDL::Surface.loadBMP(filename)Windows の BMP ファイルからサーフェスをロードします。
SDL::Surfaceのインスタンスを返します。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::Surface.load_bmp_from_io(io)SDL::Surface.loadBMPFromIO(io)RubyのIOオブジェクトから BMP ファイルをサーフェスにロードします。
SDL::Surfaceのインスタンスを返します。
失敗したときには例外SDL::Errorを発生させます。
NOTES
RubyのIOオブジェクトとは、read、rewind、tell という3つのメソッドを 持つオブジェクトです。IO、StringIO、Zlib::GzipReaderなどが 利用できます。
See Also
SDL::Surface#save_bmp(filename)SDL::Surface#saveBMP(filename)selfの内容をWindows の BMP ファイル filename にセーブします。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::Surface#destroySDL::Surface#destroyed?See Also
SDL::Surface#set_color_key(flag,key)SDL::Surface#setColorKey(flag,key)blit 転送可能なサーフェスのカラーキー(透明ピクセル)をセットし、 RLE アクセラレーションを有効または無効にします。 keyはピクセル値もしくは色を表す配列で指定できます。
RLE (Run-length encoding) アクセラレーションは、 透明ピクセル(つまりkeyと同じ値のピクセル)が 水平方向に長く続いている場合に、 画像の blit 転送を実質スピードアップさせることができます。 keyとしてピクセル値を使う場合、selfと 同じピクセルフォーマットのものでなければいけません。
flag が SDL::SRCCOLORKEY ならば、key は転送元の画像の透明色です。
flag に SDL::RLEACCEL が セットされている場合は、 SDL::Surface.blit で描かれる時に、 サーフェスは RLE アクセラレーションを使って描きます。 最初にサーフェスに対して SDL::Surface.blit か SDL::Surface#display_format が 呼ばれた時に、実際に RLE アクセラレーションのためエンコードされます。
flag が 0 ならば、このメソッドは現在のカラーキーをクリアします。
失敗したときには例外SDL::Errorを発生させます。
SDL::Surface#set_alpha(flags,alpha)SDL::Surface#setAlpha(flags,alpha)このメソッドはサーフェス単位のα値をセットしたり、 αブレンディングを有効に、また無効にするために使われます。
flags は、αブレンディングが使われるべきかどうか SDL::SRCALPHA、 また blit の際に RLE アクセラレーションを使うべきかどうか SDL::RLEACCELを指定するのに使われます。 flags はこれらの 2 つのオプションの OR による 組み合わせか、どちらか 1 つか、または 0 になり得るでしょう。 SDL::SRCALPHA がフラグとして渡されないと、 サーフェスを blit するときに全てのα情報は無視されます。 alpha パラメータはサーフェス単位のα値です。 つまり、サーフェス単位のαを使うには、サーフェスのαチャンネルは不要であり、 blit は未だ SDL::RLEACCEL によってアクセラレートされる ことが可能です。
αは以下の方法でサーフェスの blit に影響を及ぼします。
失敗したときには例外SDL::Errorを発生させます。
NOTES
この関数と SDL のαブレンディングの意味合いがバージョン 1.1.4 から変わりました。 バージョン 1.1.5 までは、α値 0 は不透明で、255 は透明とみなされていました。 これは今では反転されました。 つまり、0 (SDL::ALPHA_TRANSPARENT) は透明であり、 255 (SDL::ALPHA_OPAQUE) は不透明とみなされています。
サーフェス単位のα値 128 は特殊な場合とみなされて最適化されるため、 他の値よりもはるかに高速です。
SDL::SRCALPHA がセットされた状態での RGBA->RGBA の blit は 転送先サーフェスのαをそのまま維持することに注意して下さい。 これは、2 つの任意の RGBA サーフェスを合成して それらの「重ね合わせ」が期待されるような結果を得ることはできないということです。 転送先のαはマスクとして働きます。
また、ピクセル単位のαとサーフェス単位のαは合成できないことにも注意して下さい。 ピクセル単位のαが有効な時は必ずそちらが使われます。
See Also
SDL::Surface#map_rgba, SDL::Surface#get_rgba, SDL::Surface#display_format, SDL::Surface.blit, SDL::Surface#alpha
SDL::Surface#set_clip_rect(x,y,w,h)SDL::Surface#setClipRect(x,y,w,h)サーフェスのクリッピング矩形をセットします。 このサーフェスが blit 転送の転送先である場合は、 クリッピング矩形の内部の領域だけが描画されます。
引数によって指定された矩形はサーフェスの端でクリッピングされ、 サーフェスに対するクリッピング矩形がサーフェスの端に出ないようにします。
See Also
SDL::Surface#get_clip_rectSDL::Surface#getClipRectサーフェスのクリッピング矩形を取得します。 このサーフェスが blit の転送の場合は、 クリッピング矩形の内部の領域のみが描画されます。
[x, y, w, h]という整数4個の配列を返します。
See Also
SDL.blit_surface(src,srcX,srcY,srcW,srcH,dst,dstX,dstY)SDL.blitSurface(src,srcX,srcY,srcW,srcH,dst,dstX,dstY)SDL::Surface.blit(src,srcX,srcY,srcW,srcH,dst,dstX,dstY)転送元サーフェスから転送先サーフェスへ高速 blit 転送を行います srcが転送元、dstが転送先のサーフィスとなります。 srcX、srcY、srcW、srcHがすべて0の場合はsrc 全体がコピーされます。
blit はロックされたサーフェス上で呼ばれるべきではありません。
blit 操作の結果は SDL::SRCAPLHA がセットされているか否かによって 大きく変化します。 これがどのように結果に影響するかについては、 Surface#set_alpha を見て下さい。 以下の擬似コードのようにカラーキーとα属性もサーフェスの blit に作用します。
if 転送元サーフェスに SDL::SRCALPHA がセットされている
if 転送元サーフェスにαチャンネルがある (つまり Amask != 0)
ピクセル単位のα値を使い、カラーキーを無視して blit
elsif 転送元サーフェスに SDL::SRCCOLORKEY がセットされている
カラーキーとサーフェス単位のα値を使って blit
else
サーフェス単位のα値を使って blit
end
elsif 転送元サーフェスに SDL::SRCCOLORKEY がセットされている
カラーキーを使って blit
else
普通の矩形 blit
end
成功時には0を返します。
どちらかのサーフェスがビデオメモリにあり、このメソッドが 例外SDL::Surface::VideoMemoryLostを発生させる場合は、 ビデオメモリが失われたため、 画像込みでもう一度ロードして blit する必要があります。
これは DirextX5.0 の下で、 システムがあなたのフルスクリーンアプリケーションを切り換える時に発生します。 あなたがビデオメモリに再度アクセスするまでは サーフェスのロックも失敗するでしょう。
SDL::Surface#fill_rect(x,y,w,h,color)SDL::Surface#fillRect(x,y,w,h,color)与えられた矩形領域と color で 高速な塗り潰しを行います。 colorは色、ピクセルフォーマット、ピクセル値についてに書かれて いる方法で指定できます。
色の値がα値を含んでいる場合は、塗り潰し先は単にそのα情報で「塗り潰され」、 ブレンディングは起こりません。 塗り潰し先にクリッピング矩形がある場合(SDL::Surface#set_clip_rectに よってセットされます)は、このメソッドはクリッピング矩形と 指定した矩形が 重なった領域でクリッピングされます。
失敗したときには例外SDL::Errorを発生させます。
SDL::Surface#display_formatSDL::Surface#displayFormatこのメソッドはselfを表示サーフェス上への高速 blit に適するように、 ビデオフレームバッファのピクセルフォーマットとパレットの 新しいサーフェスを作ります。
ハードウェアによるカラーキーやαの blit 転送のアクセラレーション の利点を得たい場合は、 このメソッドを呼ぶ前にカラーキーとα値をセットしておくべきです。
変換後のサーフェスを返します。
変換に失敗するか、メモリを使い切った時は例外SDL::Errorを返します。
SDL::Surface#display_format_alphaSDL::Surface#displaFormatAlphaこのメソッドはselfを表示サーフェス上への高速 blit に適するように、 ビデオフレームバッファのピクセルフォーマット・色にαチャンネルを加えた 新しいサーフェスにコピーします。
ハードウェアによるカラーキーやαの blit 転送のアクセラレーション の利点を得たい場合は、 このメソッドを呼ぶ前にカラーキーとα値をセットしておくべきです。
selfに SDL::SRCCOLORKEY フラグがセットされている 場合は、このメソッドはカラーキーをαチャンネルに変換することに使うことが できます。 そうして生成されたサーフェスは、 カラーキーに一致するピクセルでは透明(α=0)に、 他の場所では不透明(α=255)になります。
変換後のサーフェスを返します。
変換に失敗するか、メモリを使い切った時は例外SDL::Errorを返します。
SDL::Surface#flagsサーフェスにセットされているフラグを返します。以下のフラグが サポートされています。
以上のフラグの OR を取ったものが返されます。
See Also
SDL::Surface#formatSDL::Surface#wSee Also
SDL::Surface#hSee Also
SDL::Surface#pixelsNOTES
これにアクセスするにはロックが必要です。
See Also
SDL::PixelFormat#RmaskSDL::PixelFormat#GmaskSDL::PixelFormat#BmaskSDL::PixelFormat#AmaskSDL::PixelFormat#RlossSDL::PixelFormat#GlossSDL::PixelFormat#BlossSDL::PixelFormat#AlossSDL::PixelFormat#RshiftSDL::PixelFormat#GshiftSDL::PixelFormat#BshiftSDL::PixelFormat#AshiftSDL::Surface#colorkeySDL::Surface#alphaSee Also
SDL::PixelFormat#colorkeySDL::PixelFormat#alphaSee Also
SDL::Surface#bppSDL::PixelFormat#bppSDL::Surface#pitchサーフェスの各スキャンラインに使われるバイト数を返します。 SDL::Surface#pixels で得られる画像データの解釈に必要となります。 おおよそ SDL::Surface#bpp * SDL::Surface#w / 8 の値となりますが、 パディングのため少しこれより大きくなる場合があります。
SDL::Surface#pixels で得られるデータのバイト数は SDL::Surface#h * pitch と なります。
SDL::Surface.load(filename)画像のファイルをサーフェスにロードします。 もし画像の形式が透明ピクセルをサポートしているならば、サーフェスに カラーキーがセットされます。
対応しているフォーマットはBMP, PNM (PPM/PGM/PBM), XPM, XCF, PCX, GIF, JPEG, TIFF, TGA, PNG, LBMです。
失敗したときには例外SDL::Errorを発生させます。
このメソッドを使うには SDL_image が必要です。
NOTES
SDL_image のコンパイル時に使えるように指定しなかったフォーマット のファイルはこのメソッドではロードできません。
SDL::Surface.load_from_io(io)SDL::Surface.loadFromIO(io)RubyのIOオブジェクトから画像データをサーフェスにロードします。 もし画像の形式が透明ピクセルをサポートしているならば、サーフェスに カラーキーがセットされます。
対応しているフォーマットはBMP, PNM (PPM/PGM/PBM), XPM, XCF, PCX, GIF, JPEG, TIFF, TGA, PNG, LBMです。
失敗したときには例外SDL::Errorを発生させます。
NOTES
RubyのIOオブジェクトとは、read、rewind、tell という3つのメソッドを 持つオブジェクトです。IO、StringIO、Zlib::GzipReaderなどが 利用できます。
See Also
SDL::Surface#put_pixel(x, y, color)SDL::Surface#putPixel(x, y, color)SDL::Surface#[x, y] = colorサーフェスの(x, y)で指定した位置にcolorのピクセルを描画します。 colorとしてピクセル値もしくは色を表わす配列が利用できます。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
See Also
SDL::Surface#get_pixel(x, y)SDL::Surface#getPixel(x, y)SDL::Surface#[x, y]サーフェスの(x, y)で指定した位置のピクセル値を得ます。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
See Also
SDL::Surface#put(src, x, y)selfの(x, y)で指定した位置にサーフェス src を高速 blit 転送 します。
これは、
SDL::Surface.blit(src, 0, 0, src.w, src.h, self, x, y)
と同じです。
See Also
SDL::Surface#copy_rect(x,y,w,h)SDL::Surface#copyRect(x,y,w,h)サーフェス self の (x, y, w, h) で指定される矩形を コピーした新しいサーフェスを作り、返します。
失敗したときには例外SDL::Errorを発生させます。
NOTES
このメソッドは内部で SDL::Surface.blit を呼ぶため、ロックされたサーフェス上で 呼ばれるべきではありません。
SDL.auto_lock?SDL.autoLock?SDL.auto_lockSDL.autoLockこのメソッドの利用は推奨されません。代わりにSDL::Surface.auto_lock?を利用してください。
このメソッドを使うには SGE が必要です。
SDL::Surface.auto_lock?SDL::Surface.autoLock?サーフェスに対するロックが必要な操作をするとき、 Ruby/SDLが自動的にロック/アンロックするか どうかを true/false で返します。デフォルトでは true です。
このメソッドを使うには SGE が必要です。
SDL.auto_lock_onSDL.autoLockONこのメソッドの利用は推奨されません。代わりにSDL::Surface.auto_lock_onを利用してください。
このメソッドを使うには SGE が必要です。
SDL::Surface.auto_lock_onSDL::Surface.autoLockON自動ロックを利用するようにします。これを呼ぶとSDL.auto_lock?が真に なります。
このメソッドを使うには SGE が必要です。
SDL.auto_lock_offSDL.autoLockOFFこのメソッドの利用は推奨されません。代わりにSDL::Surface.auto_lock_offを利用してください。
このメソッドを使うには SGE が必要です。
SDL::Surface.auto_lock_offSDL::Surface.autoLockOFF自動ロックを利用しないようにします。これを呼ぶとSDL.auto_lock?が偽に なります。
このメソッドを使うには SGE が必要です。
SDL.auto_lock=(locking)SDL.autoLock=(locking)このメソッドの利用は推奨されません。代わりにSDL::Surface.auto_lock_onを利用してください。
自動ロックを使うかどうかを設定します。 SDL.auto_lock = true は SDL.auto_lock_on と同じで、 SDL.auto_lock = false は SDL.auto_lock_off と 同じです。
このメソッドを使うには SGE が必要です。
SDL.transform(src,dst,angle,xscale,yscale,px,py,qx,qy,flags)このメソッドの利用は推奨されません。代わりにSDL::Surface.transform_drawを利用してください。
このメソッドを使うには SGE が必要です。
SDL::Surface.transform_draw(src,dst,angle,xscale,yscale,px,py,qx,qy,flags)srcを回転縮小拡大したものをdstに描画します。 angleは回転角度(単位はラジアンではなく度)、xscale、yscaleは それぞれX方向とY方向の倍率、(px, py) は srcにおける回転の 中心で、その点がdstの(qx, qy)にくるように描画されます。 また、flagsとしては以下の値のORを取ったものを与えます。
このメソッドを使うには SGE が必要です。
NOTES
最適なパフォーマンスを得るために、src と dst は同じピクセル フォーマットを使い、また24bpp以外のフォーマットを使ってください。
SDL::Surface#set_clip_rect で設定したクリッピング矩形は src および dst で有効です。
SDL::Surface::TRANSFORM_AA を使う場合は、高さ方向および幅方向にそれぞれ 1ピクセルづつ間引かれます(パフォーマンスを良くするためです)。
srcが32bpp RGBA フォーマットの場合には、SDL::Surface::TRANSFORM_SAFEを使うべきです。
このメソッドはアルファブレンディングは一切しませんが、アルファチャンネルの 値は保ちます。もし、アルファブレンディング、カラーキーの効果のある 回転縮小拡大描画をしたい場合はSDL::Surface.transform_blitをかわりに利用してください。
See Also
SDL::Surface.transform_blit, SDL::Surface#transform_surface, SDL::Surface.new
SDL.transform_blit(src,dst,angle,xscale,yscale,px,py,qx,qy,flags)SDL.transformBlit(src,dst,angle,xscale,yscale,px,py,qx,qy,flags)このメソッドの利用は推奨されません。代わりにSDL::Surface.transform_blitを利用してください。
このメソッドを使うには SGE が必要です。
SDL::Surface.transform_blit(src,dst,angle,xscale,yscale,px,py,qx,qy,flags)SDL::Surface.transformBlit(src,dst,angle,xscale,yscale,px,py,qx,qy,flags)回転縮小拡大描画をします。引数の意味などは SDL::Surface.transform_draw と同様です。 SDL::Surface.transform_draw との違いは src に設定されたカラーキー(抜き色) およびアルファブレンディングが有効になることです。
このメソッドを使うには SGE が必要です。
SDL::Surface#draw_line(x1,y1,x2,y2,color, aa=false, alpha=nil)SDL::Surface#drawLine(x1,y1,x2,y2,color, aa=false, alpha=nil)(x1, y1)から(x2, y2)までの直線を color で指定した色で描画します。aaが真ならば アンチエイリアシングされた直線を描画します。 alphaが整数である場合はその値をα値として アルファブレンディングで描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_aa_line(x1,y1,x2,y2,color)SDL::Surface#drawAALine(x1,y1,x2,y2,color)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_lineを利用してください。
(x1, y1)から(x2, y2)までの直線を color で指定した色で アンチエイリアスして描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_line_alpha(x1,y1,x2,y2,color,alpha)SDL::Surface#drawLineAlpha(x1,y1,x2,y2,color,alpha)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_lineを利用してください。
(x1, y1)から(x2, y2)までの直線を color で指定した色、 alphaで指定したα値で描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_aa_line_alpha(x1,y1,x2,y2,color,alpha)SDL::Surface#drawAALineAlpha(x1,y1,x2,y2,color,alpha)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_lineを利用してください。
(x1, y1)から(x2, y2)までの直線を color で指定した色、 alphaで指定したα値でアンチエイリアスをかけて描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_rect(x,y,w,h,color, fill=false, alpha=nil)SDL::Surface#drawRect(x,y,w,h,color, fill=false, alpha=nil)(x, y)が左上の点でwが幅、hが高さの長方形を
((|color|)) で
指定した色で描画します。fillが真ならを中を塗り潰し、 偽なら塗り潰しません。 また、alphaが整数ならばその値をα値としてアルファ ブレンディング描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_rect_alpha(x,y,w,h,color,alpha)SDL::Surface#drawRectAlpha(x,y,w,h,color,alpha)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_rectを利用してください。
(x, y)が左上の点でwが幅、hが高さの長方形を color で 指定した色、alpha で指定したα値で描画します。中を塗り潰しません。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_filled_rect_alpha(x,y,w,h,color,alpha)SDL::Surface#drawFilledRectAlpha(x,y,w,h,color,alpha)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_rectを利用してください。
(x, y)が左上の点でwが幅、hが高さの中を塗り潰した 長方形を color で指定した色、alpha で指定したα値で描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_circle(x,y,r,color,fill=false,aa=false,alpha=0)SDL::Surface#drawCircle(x,y,r,color,fill=false,aa=false,alpha=0)中心 (x,y)、半径 rの円を color で指定した色 で描画します。fillが真なら中を塗り潰し、偽なら塗り潰しません。 aaが真ならアンチエイリアスをかけます。 また、alphaを整数にするとその値をα値として アルファブレンディング描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
NOTES
塗り潰し(fill)、アンチエイリアス(aa)、 アルファブレンディング(alpha)をすべて有効にして 描画することはできません。
See Also
SDL::Surface#draw_filled_circle(x,y,r,color)SDL::Surface#drawFilledCircle(x,y,r,color)このメソッドの利用は推奨されません。代わりにSDL.draw_circleを利用してください。
中心 (x,y)、半径 rの円を color で指定した色で中を 塗り潰して描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_aa_circle(x,y,r,color)SDL::Surface#drawAACircle(x,y,r,color)このメソッドの利用は推奨されません。代わりにSDL.draw_circleを利用してください。
中心 (x,y)、半径 rの円を color で指定した色で アンチエイリアスをかけて描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_aa_filled_circle(x,y,r,color)SDL::Surface#drawAAFilledCircle(x,y,r,color)このメソッドの利用は推奨されません。代わりにSDL.draw_circleを利用してください。
中心 (x,y)、半径 rの円を color で指定した色で 中を塗り潰しアンチエイリアスをかけて描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_circle_alpha(x,y,r,color,alpha)SDL::Surface#drawCircleAlpha(x,y,r,color,alpha)このメソッドの利用は推奨されません。代わりにSDL.draw_circleを利用してください。
中心 (x,y)、半径 rの円を color で指定した色、 alphaで指定したアルファ値で描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_filled_circle_alpha(x,y,r,color,alpha)SDL::Surface#drawFilledCircleAlpha(x,y,r,color,alpha)このメソッドの利用は推奨されません。代わりにSDL.draw_circleを利用してください。
中心 (x,y)、半径 rの中を塗り潰した円を color で指定した色、 alphaで指定したアルファ値で描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_aa_circle_alpha(x,y,r,color,alpha)SDL::Surface#drawAACircleAlpha(x,y,r,color,alpha)このメソッドの利用は推奨されません。代わりにSDL.draw_circleを利用してください。
中心 (x,y)、半径 rの円を color で指定した色、 alphaで指定したアルファ値でアンチエイリアスで描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_ellipse(x,y,rx,ry,color, fill=false, aa=false, alpha=nil)SDL::Surface#drawEllipse(x,y,rx,ry,color, fill=false, aa=false, alpha=nil) )中心 (x,y)、X方向の半径 xr、Y方向の半径 ry の楕円を color で指定した色で描画します。 fillが真なら中を塗り潰し、偽なら塗り潰しません。 aaが真ならアンチエイリアスをかけます。 また、alphaを整数にするとその値をα値として アルファブレンディング描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
NOTES
塗り潰し(fill)、アンチエイリアス(aa)、 アルファブレンディング(alpha)をすべて有効にして 描画することはできません。
See Also
SDL::Surface#draw_filled_ellipse(x,y,rx,ry,color)SDL::Surface#drawFilledEllipse(x,y,rx,ry,color)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_ellipseを利用してください。
中心 (x,y)、X方向の半径 xr、Y方向の半径 ry の楕円を color で指定した色で中を 塗り潰して描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_aa_ellipse(x,y,rx,ry,color)SDL::Surface#drawAAEllipse(x,y,rx,ry,color)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_ellipseを利用してください。
中心 (x,y)、X方向の半径 xr、Y方向の半径 ry の楕円を color で指定した色で アンチエイリアスをかけて描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_aa_filled_ellipse(x,y,rx,ry,color)SDL::Surface#drawAAFilledEllipse(x,y,rx,ry,color)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_ellipseを利用してください。
中心 (x,y)、X方向の半径 xr、Y方向の半径 ry の楕円を color で指定した色で 中を塗り潰しアンチエイリアスをかけて描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_ellipse_alpha(x,y,rx,ry,color,alpha)SDL::Surface#drawEllipseAlpha(x,y,rx,ry,color,alpha)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_ellipseを利用してください。
中心 (x,y)、X方向の半径 xr、Y方向の半径 ry の楕円を color で指定した色、 alphaで指定したアルファ値で描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_filled_ellipse_alpha(x,y,rx,ry,color,alpha)SDL::Surface#drawFilledEllipseAlpha(x,y,rx,ry,color,alpha)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_ellipseを利用してください。
中心 (x,y)、X方向の半径 xr、Y方向の半径 ry の中を塗り潰した楕円を color で指定した色、 alphaで指定したアルファ値で描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_aa_ellipse_alpha(x,y,rx,ry,color,alpha)SDL::Surface#drawAAEllipseAlpha(x,y,rx,ry,color,alpha)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_ellipseを利用してください。
中心 (x,y)、X方向の半径 xr、Y方向の半径 ry の楕円を color で指定した色、 alphaで指定したアルファ値でアンチエイリアスで描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_bezier(x1,y1,x2,y2,x3,y3,x4,y4,level,color,aa=false,alpha=nil)SDL::Surface#drawBezier(x1,y1,x2,y2,x3,y3,x4,y4,level,color,aa=false,alpha=nil)(x1, y1) から (x4, y4)までのベジエ曲線を (x2, y2) と (x3, y3) をコントロールポイントとして colorで指定した色で 描画します。level は曲線の近似度で、 4から7を使うと良いでしょう。 aaが真ならアンチエイリアスをかけます。 また、alphaを整数にするとその値をα値として アルファブレンディング描画します。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
SDL::Surface#draw_aa_bezier(x1,y1,x2,y2,x3,y3,x4,y4,level,color)SDL::Surface#drawAABezier(x1,y1,x2,y2,x3,y3,x4,y4,level,color)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_bezierを利用してください。
(x1, y1) から (x4, y4)までのベジエ曲線を (x2, y2) と (x3, y3) をコントロールポイントとして colorで指定した色でアンチエイリアスして 描画する。leve は曲線の近似度で、4から7を使うと良い。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_bezier_alpha(x1,y1,x2,y2,x3,y3,x4,y4,level,color,alpha)SDL::Surface#drawBezierAlpha(x1,y1,x2,y2,x3,y3,x4,y4,level,color,alpha)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_bezierを利用してください。
(x1, y1) から (x4, y4)までのベジエ曲線を (x2, y2) と (x3, y3) をコントロールポイントとして colorで指定した色、alphaで指定したα値で 描画する。leve は曲線の近似度で、4から7を使うと良い。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#draw_aa_bezier_alpha(x1,y1,x2,y2,x3,y3,x4,y4,level,color,alpha)SDL::Surface#drawAABezierAlpha(x1,y1,x2,y2,x3,y3,x4,y4,level,color,alpha)このメソッドの利用は推奨されません。代わりにSDL::Surface#draw_bezierを利用してください。
(x1, y1) から (x4, y4)までのベジエ曲線を (x2, y2) と (x3, y3) をコントロールポイントとして colorで指定した色、alphaで指定したα値でアンチエイリアス 描画する。leve は曲線の近似度で、4から7を使うと良い。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。
このメソッドを使うには SGE が必要です。
See Also
SDL::Surface#transform_surface(bgcolor,angle,xscale,yscale,flags)SDL::Surface#transformSurface(bgcolor,angle,xscale,yscale,flags)self を拡大縮小変形したサーフェスを生成し返す。 回転によって生じた隙間は bgcolor で指定した色で埋められる。 引数 angle、xscale、yscale、flags は SDL::Surface.transform_draw と同じ意味である。
新しいサーフェスは self と同じ bpp およびピクセルフォーマットを 持つ。
このメソッドを使うにはサーフェスをロックする必要があります。 SDL.auto_lock?が真の場合はシステムが自動的にロック/アンロックします。 失敗したときには例外SDL::Errorを発生させます。
このメソッドを使うには SGE が必要です。
Ruby/SDL は、いくつかのプラットフォーム(Linux/X11, Win32, MacOS X, etc)において、 OpenGL コンテキストを生成し使うことができます。 これにより、OpenGLと同時に Ruby/SDLのオーディオ・イベント処理・ タイマーを使うことができます。
Ruby/SDL そのものは OpenGL 用のメソッドを持っていません。 ruby-opengl, riko などを利用してください。
OpenGL を使うための Ruby/SDLの初期化は、 普通に Ruby/SDL を初期化するのと 大きな違いはありません。3 つの違いがあります。 SDL::Screen.openにSDL::OPENGLを渡す必要があり、 SDL::GL.set_attrを使って いくつかの GL 属性(デプスバッファのサイズ・ フレームバッファのサイズ)を指定する必要があり、 そして最後にダブルバッファを使いたいなら SDL::Screen.openにSDL::DOUBLEBUF フラグを渡すことによってではなく、 GL アトリビュートとして指定する必要があります。
EXAMPLE
# まず、ビデオサブシステムを初期化 SDL.init(SDL::INIT_VIDEO) # いくつかのビデオ情報を取得 info = SDL::Screen.info # 画面を640x480にセット width = 640; height = 480; # 画面から要求していたピクセル深度を取得。 bpp = info.bpp # ここで、OpenGL ウィンドウのために # 要求されたウィンドウ属性を設定したい。 # RGB 各チャンネルに *少なくとも* 5 ビット欲しい。 # また、少なくとも 16 ビットのデプスバッファも欲しい。 # # 最後にする事はダブルバッファウィンドウの要求である。 # '1' でダブルバッファが有効になり、 # '0' で無効になる。 # # SDL::Screen.open へのフラグにおいて # SDL::DOUBLEBUF を使わない事に注意。 # それは GL アトリビュートに影響せず、 # 標準の 2D blit 転送の設定だけに影響する。 SDL::GL.set_attr(SDL::GL::RED_SIZE, 5) SDL::GL.set_attr(SDL::GL::GREEN_SIZE, 5) SDL::GL.set_attr(SDL::GL::BLUE_SIZE, 5) SDL::GL.set_attr(SDL::GL::DEPTH_SIZE, 16) SDL::GL.set_attr(SDL::GL::DOUBLEBUFFER, 1) # SDL がフルスクリーンビデオモードにおいて # OpenGL ウィンドウを提供してくれるよう要求したい。 flags = SDL:;OPENGL | SDL::FULLSCREEN # ビデオモードを設定。 SDL::Screen.open(width, height, bpp, flags)
SDL::GL.get_attr や SDL::GL.set_attr では以下の属性を利用 できます。
描画は基本的に OpenGL のAPIがそのまま使えます。 しかし、ダブルバッファ画面を使うときは、 バッファを交換し画面を更新するために SDL::GL.swap_buffersを使う必要があります。 OpenGL でダブルバッファを要求するためには、 SDL::GL.set_attr(SDL::GL::DOUBLEBUFFER, 1) とする必要があり、実際に得られたかどうかを確認するために SDL::GL.get_attr(SDL::GL::DOUBLEBUFFER) とします。
SDL::GL.get_attr(attr)SDL::GL.getAttr(attr)OpenGL属性 attr の値を返します。 これは、SDL::Screen#openの呼び出しの後に、あなたの指定した 属性が期待通りにセットされたかどうかをチェックするのに有効 です。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::GL.set_attr(attr, val)SDL::GL.setAttr(attr, val)OpenGLの属性 attr を val にセットします。 セットした属性は、SDL::Screen.open の呼び出しまでは有効になりません。 SDL::Screen.openの呼び出しの後は、SDL::GL.get_attr を使って値をチェックすべきです。
失敗したときには例外SDL::Errorを発生させます。
NOTES
OpenGL ビデオモードをセットする時、 ダブルバッファを有効にするためには SDL;;DOUBLEBUF は必要ではありません。 ダブルバッファは SDL::GL::DOUBLEBUFFER 属性を使うことで 有効または無効になります。
See Also
SDL::GL.swap_buffers()SDL::GL.swapBuffers()See Also
SDL::GL.set_attr, SDL::GL::Screen.open
SDL はウィンドウ管理の機能の一部を提供しており、 アプリケーションが自身のタイトルを変更したり、 フルスクリーンモードがサポートされていれば ウィンドウモードとフルスクリーンモードとを切り換える ことができます。
SDL::WM.captionNOTES
返り値のエンコーディングはUTF8です。
See Also
SDL::WM.set_caption(title, icon)SDL::WM.setCaption(title, icon)NOTES
Ruby 1.8では文字列としてUTF8を与えることでマルチバイト文字列が 利用できる環境もあります。
Ruby 1.9ではRuby/SDLのm17n機能を有効にしている限り Rubyのm17nの機能を用いUTF8への変換を自動的に行います。
See Also
SDL::WM.icon=(icon_image)表示ウィンドウにアイコンをセットします。 Win32 のアイコンは 32×32 でなければいけません。
このモジュール関数は、SDL.set_video_mode を 初めて呼ぶ前に呼ばれなければいけません。 iconとしては SDL::Surface のインスタンスを与えます。
EXAMPLE
SDL::WM.icon = SDL::Surface.load_bmp("icon.bmp")
See Also
SDL::WM.iconifyウィンドウを管理する環境でアプリケーションが実行されている場合、 Ruby/SDL はアプリケーションをアイコン化/最小化することを試みます。 もし成功すれば、アプリケーションは SDL::Event::APPACTIVE を失なった イベントを受け取るでしょう。
失敗したときには例外SDL::Errorを発生させます。
SDL::WM.grab_input(mode)SDL::WM.grabInput(mode)つかむ(Grabbing)とは、マウスがアプリケーションウィンドウに閉じ込められ、 ほぼ全てのキーボード入力が直接アプリケーションに転送され、 ウィンドウマネージャにも解釈されないことを表します。
mode として以下の定数を与えることができます。
mode が SDL::WM::GRAB_QUERY のときは、 grab モードは変更されないで現在の grab モードが返されます。
現在の、あるいは新しいモードを返します。
イベント処理によってあなたのアプリケーションはユーザーからの 入力を受け取ることができます。 イベント処理は次のメソッドを呼ぶことで、(ビデオと一緒に)初期化されます。
SDL.init(SDL::INIT_VIDEO)
内部的には、SDL は処理されるまで待機している全てのイベントをイベントキューに 格納します。
SDL::Event.poll や SDL::Event.wait のようなメソッドを使うことで、 待機している入力イベントを見たり、処理することができます。
Ruby/SDLにおけるイベント処理の鍵は、SDL::Eventのサブクラス群です。 イベントキュー自身はSDL::Event(のサブクラス)のインスタンスの列と みなすことができます。それらのオブジェクトはSDL::Event.pollを使って キューから読みだされ、 そしてそこに格納された情報の処理をアプリケーションがします。
SDL::Eventのサブクラスは以下の通りです。
イベントクラスには以下の二つの用途があります。
キューからイベントを読み出すには、 SDL::Event.poll を使います。 ここでは、 SDL::Event.poll を使った例を示します。
while event = SDL::Event.poll
SDL::Event.poll はイベントキューから次のイベントを 取り出して、キューから削除します。キューにイベントがないときは nil を返し、それ以外の場合は上に挙げたイベントクラスのインスタンス を返します。
次に、イベントの種類を判別するために case〜when 文を使います。
case event
次に、どの種類のイベントを知りたいのかということと、起こった イベントの種類を知らなければいけません。 ここでは、アプリケーション内のマウスポインタの動きを知りたいとします。 求めているイベントに対応するクラスはSDL::Event::MouseMotion であることがわかります。case〜when 文の when の所にクラスを書くと、 そのクラスのインスタンスをcaseに与えたときに分岐することを利用します
when SDL::Event::MouseMotion
ここでは event は SDL::Event::MouseMotion のインスタンスなので そのメソッドを使って情報を得ることができます。
puts "マウスカーソルが移動するイベントを受信しました。"
puts "カーソルの位置は(#{event.x}, #{event.y})です。"
else puts "ハンドルしていないイベントです!" end
end puts "イベントキューは空です。"
イベントキューにイベントを送ることもできますので、 イベントキューを双方向通信に利用することもできます。 SDL::Event.pushでイベントキューにイベントを送ることができます。 偽の入力イベントを作り出したりするために使うことができます。 ユーザイベントは Ruby/SDL では利用できません。
イベントを取り扱うためのクラスです。実際のクラスはこのクラスのサブクラス として表されます。
かつてSDL::Eventという名前だったクラスは廃止されました。 現在SDL::Eventという名前のクラスは以前は SDL::Event2という名前でした。 この変更のため、旧 SDL::Event を使っていると 互換性がありません。また、SDL::Event2という名前は互換性 のため残されています。
アプリケーションの可視性に関するイベントのクラスです。
マウスカーソルのウインドウの出入り、 キーボードフォーカスの得失、および 最小化/アイコン化されたり元に戻ったときに発生します。
上のいずれが生じたのかは SDL::Event::Active#state でわかります。
NOTES
このイベントは、最初にウィンドウが作成されたときには発生しません。
キーボードを押したときに発生するイベントのクラスです。
キーボードを離したときに発生するイベントのクラスです。
マウスを動かしたときに発生するイベントのクラスです。
簡単に言うと、 このイベントは アプリケーションウィンドウの中でユーザーがマウスを動かしたとき、 または SDL::Mouse.warp が呼ばれた時に発生します。 現在のボタンの状態(SDL::Event::MouseMotion#state)とともに、 絶対座標(SDL::Event::MouseMotion#x と SDL::Event::MouseMotion#y) と相対座標(SDL::Event::MouseMotion#xrel と SDL::Event::MouseMotion#yrel) の両方が報告されます。
マウスボタンを押したときのイベントのクラスです。
マウスボタンを離したときのイベントのクラスです。
ジョイスティックの軸イベントのクラスです。
ユーザがジョイスティックの軸を移動させるとこのイベントが発生します。
SEEALSO
((<SDL::Joystick#num_axes>))、((<SDL::Joystick#axis>))
ジョイスティックのトラックボールの動きイベントのクラスです。
SEEALSO
ジョイスティックのハットスイッチの位置変化イベントのクラスです。
SEEALSO
ジョイスティックのボタンが押し下げられたときに発生するイベントのクラスです。
SEEALSO
ジョイスティックのボタンを離したときに発生するイベントのクラスです。
SEEALSO
終了要請イベントのクラスです。
終了イベントを無視すると、 ユーザーはウィンドウを閉じることが不可能になります。 一方で、終了イベントを受け入れるならば、 アプリケーションウィンドウは閉じられて アプリケーションは見えなくなりますが、 画面更新はそれでも成功イベントを報告します。
プラットフォーム依存のウィンドウマネージャイベントのクラスです。
ウィンドウマネージャから処理できないイベントを受け取った時はいつでも 生成されます。Ruby/SDL からはいかなるイベントであるのかを知ることは できません。ただ存在するだけで有用でないイベントです。 Ruby からは無視する以外のことはできません。
ウィンドウのリサイズイベントのクラスです。
SDL::RESIZABLE が flag として SDL::Screen.open に 渡された時は、ユーザーはアプリケーションウィンドウをリサイズすることが 許されます。 ウィンドウがリサイズされた時は、このイベントが発生し、 SDL::Event::VideoResize#w と SDL::Event::VideoResize#h から ウィンドウの新しい横幅と高さが得られます。
このイベントを受け取ると、ウィンドウは SDL::Screen.openを使って新しい寸法にリサイズされるはずです。
再描画に関するイベントのクラスです
このイベントは他のアプリケーション、通常はウインドウマネージャによってscreen が変更されたときに発生し、再描画の必要性を通知します。
キーボード入力関連を取り扱うモジュールです。
キーボード関連の定数とモジュール関数が定義されています。
SDL::Key にはキーボードのそれぞれのキーに対応する以下の定数が定義されています。
マウス入力関連を取り扱うモジュールです。
マウス関連の定数とモジュール関数が定義されています。
SDL::Event.poll現在留まっているイベントを取り出し、イベントがあるときはそのイベントを、 無いときは nil を返します。イベントが取り出されたときは キューからそのイベントを削除します。
EXAMPLE
while event = SDL::Event.poll #キューに残っているイベントがなくなるまでループ
case event # 適切なイベントタイプを処理
when SDL::Event::KeyDown # キー押下イベントを処理
puts "あ! キーを押しましたね"
when SDL::Event::MouseMotion
.
.
.
else # 未処理のイベントを報告
puts "私にはよく分からないイベントです!"
end
end
See Also
SDL::Event.wait次の利用可能なイベントが来るまで無限に待機し、 イベントが来たらそのイベントを返します。
返したイベントはキューから削除されます。
イベントを待っている間にエラーがあった場合は例外 SDL::Error を 発生させます。
NOTES
Ruby 1.8では このメソッドを呼びイベントを待っている間はRubyのスレッドは 切り替わりません。
Ruby 1.9ではイベントを待っている間に他のRubyのスレッド に切り替わることが可能です。
Ruby/SDL が対応していないイベントが生じた場合など、 このメソッドが nil を返す場合があります。 常に Event オブジェクトが返されるという仮定はしないでください。
See Also
SDL::Event.push(event)event で指定したイベントをイベントキューにプッシュします。
失敗したときには例外SDL::Errorを発生させます。
NOTES
デバイス入力イベントをキューにプッシュしても、 SDL 内のデバイスの状態は変わりません。
See Also
SDL::Event.app_stateSDL::Event.appStateSee Also
SDL::Event.enable_unicodeSDL::Event.enableUNICODENOTES
変換が有効なのはキーダウンイベントのみです。 キーリリースイベントは変換されません。
See Also
SDL::Event.disable_unicodeSDL::Event.disableUNICODESDL::Event.enable_unicode?SDL::Event.enableUNICODE?SDL::Event::Active#gainSee Also
SDL::Event::Active#stateマウスカーソルがウインドウの外に出たり(gain=false)、ウインドウ内に 入ったり(gain=true)したときは、SDL::Event::APPMOUSEFOCUS を返します。
アプリケーションがキーボードフォーカスを得たり(gain=true) 失ったり(gain=false)したときは、SDL::Event::APPINPUTFOCUS を 返します。これは通常他のアプリケーションがアクティブに なったときに発生します。
アプリケーションが最小化/アイコン化されたり(gain=false) 元に戻ったとき(gain=true)には SDL::Event::APPACTIVE を返します。
See Also
SDL::Event::KeyDown#pressSee Also
SDL::Event::KeyDown#symSee Also
SDL::Event::KeyDown#modSee Also
SDL::Event::KeyDown#unicodeSDL::Event.enable_unicode によって UNICODE 変換が有効にされた時には、 キーの押下に対応する UNICODE 文字を返します。 文字の上位 9 ビットが 0 の場合は、 ASCII 文字に対応しています。
変換が有効でない場合には0 を返します。
SDL::Event::KeyUp#pressSee Also
SDL::Event::KeyUp#symSDL::Event::KeyUp#modSee Also
SDL::Event::MouseMotion#stateSee Also
SDL::Event::MouseMotion#xSee Also
SDL::Event::MouseMotion#ySee Also
SDL::Event::MouseMotion#xrelSDL::Event::MouseMotion#yrelSDL::Event::MouseButtonDown#buttonどのボタンが押されたのかを返します。左、中央、右のボタンに対応して
が得られます。
SDL::Event::MouseButtonDown#pressSee Also
SDL::Event::MouseButtonDown#xSee Also
SDL::Event::MouseButtonDown#ySee Also
SDL::Event::MouseButtonUp#buttonどのボタンが離されたのかを返します。左、中央、右のボタンに対応して
が得られます。
SDL::Event::MouseButtonUp#pressSee Also
SDL::Event::MouseButtonUp#xSee Also
SDL::Event::MouseButtonUp#ySee Also
SDL::Event::JoyAxis#whichSee Also
SDL::Event::JoyAxis#axisSee Also
SDL::Event::JoyAxis#valueSee Also
SDL::Event::JoyBall#whichSee Also
SDL::Event::JoyBall#ballSee Also
SDL::Event::JoyBall#xrelSee Also
SDL::Event::JoyBall#yrelSee Also
SDL::Event::JoyHat#whichSee Also
SDL::Event::JoyHat#hatSee Also
SDL::Event::JoyHat#valueSDL::Event::JoyButtonDown#whichSee Also
SDL::Event::JoyButtonDown#buttonSee Also
SDL::Event::JoyButtonDown#pressSDL::Event::JoyButtonUp#whichSee Also
SDL::Event::JoyButtonUp#buttonSee Also
SDL::Event::JoyButtonUp#pressSDL::Event::VideoResize#wSDL::Event::VideoResize#hSDL::Key.scanキーボードの状態のスナップショットをとります。 SDL::Key.press?を使いこの関数で取った状態の情報を得ます。
この状態は SDL::Event.poll や SDL::Event.wait を呼ばないと更新されません。
SDL::Key.press?(key)See Also
SDL::Key.mod_stateSDL::Key.modStateモディファイアキー(CTRL、ALTなど)の状態を返します。 以下の値の論理和が帰ります。
以下のような定数も定義されています。
See Also
SDL::Key.get_key_name(key)SDL::Key.getKeyName(key)SDL::Key.enable_key_repeat(delay,interval)SDL::Key.enableKeyRepeat(delay,interval)キーリピートレートを有効にします。 delay は、リピートが開始されるまでの 時間を指定します。 その後に、intervalで指定された レートでリピートが始まります。 delay と interval は どちらもミリセカンド単位で指定します。
デフォルト値はそれぞれ SDL::Key::DEFAULT_REPEAT_DELAY と SDL::Key::DEFAULT_REPEAT_INTERVAL という定数で定義されています。
レートの変更に失敗すると例外 SDL::Error が発生します。
See Also
SDL::Key.disable_key_repeatSDL::Key.disableKeyRepeatキーリピートを無効にします。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::Mouse.state現在のマウスの状態を以下のような要素5個の配列で得ます。
[ マウスのX座標, マウスのY座標, 左ボタンが押されているか？, 中央ボタンが押されているか？, 右ボタンが押されているか？ ]
EXAMPLE
x, y, lbutton, * = SDL::Mouse.state if lbutton print "マウス左ボタン が押されました。\n" end
SDL::Mouse.warp(x,y)See Also
SDL::Mouse.showカーソルを表示します。
カーソルは最初は表示されていますが、非表示にすることもできます。
See Also
SDL::Mouse.hideSee Also
SDL::Mouse.show?See Also
SDL::Mouse.set_cursor(bitmap,white,black,transparent,inverted,hot_x=0,hot_y=0)SDL::Mouse.setCursor(bitmap,white,black,transparent,inverted,hot_x=0,hot_y=0)現在アクティブなカーソルを指定されたものに設定します。 カーソルが現在見える状態にあるときは、この変更はすぐに表示に反映されます。
カーソルは bitmap で SDL::Surface のインスタンスを指定します。 カーソルは白黒2色で作られます。white が白に対応するピクセル値、 black が黒に対応するピクセル値、transparentは透明に対応するピクセル値、 inverted は反転色(なければ黒)に対応するピクセル値です。 またカーソルの横幅は 8 の倍数でなければいけません。
hot_x、hot_y はビットマップのどの点をマウスカーソルの位置とするかを 指定します。
See Also
ジョイスティック、またそれに近い他のデバイスは、 ゲームプレイにおける非常に強い役割を持っており、 SDL はそれらを広範囲にサポートしています。 軸、ボタン、POV ハットスイッチ、そしてトラックボールは 全てサポートされてます。
ジョイスティックのサポートは SDL.init に SDL::INIT_JOYSTICK フラグを渡すことで初期化されます。 いったん初期化されたジョイスティックは SDL::Joystick.open で オープンされなければいけません。
ここに書かれているメソッドを使う時、 ジョイスティックにこちらからアクセスして読み込むのが 最良の方法のように思えますが、たいていの場合そうではありません。 理想的には、ジョイスティックはイベント システムを使って読み込むべきです。 これを可能にするために、SDL::Joystick.poll= を使ってジョイスティックのイベント処理状態を設定しなければなりません。 もちろん、ジョイスティックを使う前にオープン しなければなりません。
NOTES
イベントキューを通してジョイスティックを扱っているので なければ、 SDL::Joystick.update_all を呼んでジョイスティックの更新を明示的に要求する必要があります。
フォースフィードバックはまだサポートされていません。
個々のジョイステックから入力情報を得るためのクラスです。
SDL::Joystick.numSee Also
SDL::Joystick.index_name(index)SDL::Joystick.indexName(index)実装に依存するジョイスティック名を文字列で取得します。 index パラメータはシステム上のジョイスティック番号を指します。
EXAMPLE
# 接続された全てのジョイスティックの名前を表示
num_joy = SDL::Joystick.num
printf("%d 本のジョイスティックが見つかりました\n", num_joy)
num_joy.times do |i|
puts SDL::Joystick.index_name(i)
end
See Also
SDL::Joystick.open(index)SDL 内でジョイスティックを使うためオープンします。 index はシステムにおけるジョイスティックの番号を指します。 ジョイスティックはゲームで使用する前にオープンされる必要があります。
ジョイスティック番号は 0 から SDL::Joystick.num - 1 までが有効です。
SDL::Joystickのインスタンスを返します。
失敗したときには例外SDL::Errorを発生させます。
EXAMPLE
# ジョイスティックがあるかチェック
if SDL::Joystick.num > 0
# ジョイスティックをオープンする
joy = SDL::Joystick.open(0)
printf("0番のジョイスティックを開きました\n");
printf("名前: %s\n", SDL::Joystick.name(0))
printf("軸の数: %d\n", joy.num_axes)
printf("ボタンの数: %d\n", joy.num_buttons)
printf("ボールの数: %d\n", joy.num_balls)
end SDL::Joystick.open?(index)アプリケーションの中でジョイスティックがオープンされているかどうかを調べます。 index はシステムにおけるジョイスティックの番号を指します。
ジョイスティックが既にオープンされている場合は true を、 そうでない場合は false を返します。
See Also
SDL::Joystick#indexSDL::Joystick#num_axesSDL::Joystick#numAxesNOTES
縦軸と横軸を持つような入力装置(いわゆるアナログスティック)は軸が 2つと数えられます。
See Also
SDL::Joystick#num_ballsSDL::Joystick#numBallsSee Also
SDL::Joystick#num_hatsSDL::Joystick#numHatsSee Also
SDL::Joystick#num_buttonsSDL::Joystick#numButtonsSee Also
SDL::Joystick.poll=(enable)ジョイスティックイベントの処理を有効または無効にするために使われます。 ジョイスティックイベントの処理が無効の状態では、SDL::Joystick.update_all を使ってジョイスティックの状態を更新し、 手動でジョイスティックの情報を読み込む必要があります。
デフォルトでは有効になっています。
NOTE これを無効にするのはおすすめしません。
これを有効にしても、SDL::Joystick.openでデバイスをオープンしない 限りそのジョイステックに関するイベントは発生しません。
このメソッドを呼ぶとイベントキューの中身を勝手に捨てて しまう可能性があるので注意してください。
SDL::Joystick.pollSDL::Joystick.update_allSDL::Joystick.updateAllSDL::Joystick#axis(axis_index)self のaxis_index で指定した軸の現在の状態を返します。
最近のほとんどのジョイスティックでは、 X 軸は通常 axis 0、 Y 軸は axis 1 で表現されています。 このメソッドによって返される値は、軸の現在の位置を表わす 符号付き整数 (-32768 から 32768 まで) であり、 ぶれを考慮するためこれらの値に適当な閾値を設定しておく必要があるでしょう。
EXAMPLE
joy = SDL::Joystick.open(0) . . x_move = joy.axis(0) y_move = joy.axis(1)
See Also
SDL::Joystick#hat(hat_index)hat_index で指定したハットスイッチの現在の状態を取得します。
現在の状態は、 以下に挙げる値の 1 つまたは複数の OR による組み合わせとして 定義される符号無し整数の値として返されます。
See Also
SDL::Joystick#button(button_index)See Also
SDL::Joystick#ball(ball_index)ball_index で指定したボールの相対的な変化を取得します。
トラックボールは 前回のこのメソッドの呼び出しからの 相対的な動きだけを返すことができ、これらの動きの変化は [dx, dy] という形の整数2個の配列で得られます。
失敗したときには例外SDL::Errorを発生させます。
EXAMPLE
delta_x, delta_y = joy.ball(0)
printf("トラックボールの相対移動値- X:%d, Y:%d\n", delta_x, delta_y)SDL::Joystick#closeSee Also
SDL は一度に 32 までのローカル CD-ROM ドライブの オーディオ制御をサポートします。
トラック一覧の取得・再生・停止そして CD-ROM の取り出しを含む、 CD プレーヤの全ての基本的な機能を実行するためにこの API を使います。 (現在はマルチチェンジャーの CD ドライブはサポートしていません)
Ruby/SDL のどの CD-ROM 関連メソッドを呼ぶ前に、 まず SDL.init(SDL::INIT_CDROM) を呼ばなければいけません。 これは CD-ROM ドライブを探してシステムをスキャンし、 プログラムがオーディオ制御できるようセットアップします。
ライブラリを初期化した後は、 SDL::CD.num_drives を使って 利用可能なドライブがいくつあるかを知ることができます。 リストの最初のドライブはデフォルト CD-ROM ドライブです。 ドライブを選択し、SDL::CD.open でオープンした後は、 ステータスをチェックし CD がドライブにあるなら再生を開始することができます。
CD-ROM は 1 つまたはそれ以上のトラックで構成され、 個々のトラックはある数の「フレーム」で構成されています。 フレームは CD の基礎データの単位で、 それぞれのフレームはサイズにして 2K であり、 CD は通常の再生スピードにおいて 1 秒間に 75(= SDL::CD::FPS) フレーム再生されます。 SDL は CD 上のフレーム数を使って動作しますが、 SDL::CD.frames_to_msf を使うことで、 より見慣れた分/秒のフォーマットに簡単に変換することができます。 またこの変換の逆は SDL::CD.msf_to_frames でできます。
SDL::CD.open によってオープンされた CDROM デバイスを表し、 ディスクにおけるトラックのレイアウトの情報を格納します。
SDL::CD.num_drivesSDL::CD.numDrivesSee Also
SDL::CD.index_name(drive)SDL::CD.indexName(drive)CD-ROM について、人間に読めるシステム非依存の ID を文字列で返します。 drive はドライブのインデックス番号です。 インデックス番号は 0 で始まり、SDL::CD.num_drives-1 で 終わります。
返り値は例えば以下のような文字列です。
See Also
SDL::CD.open(drive)CD-ROM ドライブにアクセスするためにオープンします。 成功した場合は SDL::CD のインスタンスを返します。
ドライブが正しくないか、ビジー状態のときは例外 SDL::Error を発生させます。
EXAMPLE
SDL.init SDL::INIT_CDROM # CD ドライブをチェック if SDL::CD.num_drives == 0 # 見つからなかった STDERR.print "利用可能な CDROM デバイスがありません\n" exit 255 end begin # デフォルトドライブをオープン cdrom = SDL::CD.open(0) rescue SDL::Error # オープンできなかった STDERR.puts "ドライブがオープンできませんでした" exit 255 end # ボリュームの情報を表示 printf "名前: %s\n", SDL::CD.index_name(0) printf "トラック数: %d\n", cdrom.num_tracks num_tracks.times do |cur_track| min, sec, frame = SDL::CD.frames_to_msf(cdrom.track_length(cur_track)) printf "\tトラック %d: 長さ %d:%d\n", cur_track, min, sec end
SDL::CD#statusこの関数は指定されたドライブの現在の状態を返します。 状態は次のいずれかです。
ドライブに CD が入っていると、 SDL.current_track, SDL.current_frame, SDL.num_tracks, SDL.track_type, SDL.track_lenghtの情報が更新されます。
EXAMPLE
def play_track(track) raise "not cd in drive" unless $cdrom.in_drive? # 実際の CD のトラック数で切り捨て track = $cdrom.num_tracks-1 if track >= $cdrom.num_tracks $cdrom.play_tracks(track, 0, 1, 0) end
SDL::CD#play(start, length)self で示されるCDを フレーム startから length フレームだけ 再生します。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::CD#play_tracks(start_track, start_frame, ntracks, nframes)start_track 番目のトラックから ntracks トラック分、 指定された CD を再生します。
start_frame は 再生を始める start_track の先頭から数えた フレームのオフセット値です。 nframes は 再生を終了する最後のトラック (start_track+ntracks) の 先頭から数えたフレームのオフセット値です。
このメソッドは、SDL::CD#statusを 呼んで CD のトラック情報を取得した後にのみ、呼ぶべきです。
失敗したときには例外SDL::Errorを発生させます。
EXAMPLE
# 前もって cdrom がオープンされたデバイスだと仮定 # CD 全体を再生 if cdrom.in_drive? cdrom.play_tracks 0, 0, 0, 0 end # 最初のトラックを再生 if cdrom.in_drive? cdrom.play_tracks 0, 0, 1, 0 end # 2 番目のトラックの最初から 15 秒を再生 if cdrom.in_drive? cdrom.play_tracks 1, 0, 0, SDL::CD::FPS*15 end
NOTES
データトラックは無視されます。
See Also
SDL::CD#pause指定された CD-ROM の再生を一時停止します。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::CD#resume指定した CD-ROM の再生を再開します。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::CD#stop指定された CD-ROM の再生を停止します。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::CD#eject指定された CD-ROM を取り出します。
失敗したときには例外SDL::Errorを発生させます。
SDL::CD#num_tracksSDL::CD#numTracksSee Also
SDL::CD#current_trackSDL::CD#currentTrackSee Also
SDL::CD#current_frameSDL::CD#currentFrameSee Also
SDL::CD#track_type(track)SDL::CD#trackType(track)SDL::CD#track_length(track)SDL::CD#trackLength(track)SDL::CD#in_drive?See Also
SDL::CD.frames_to_msf(frames)SDL::CD.framesToMSF(frames)See Also
SDL::CD.msf_to_frames(min, sec, frames)SDL::CD.MSFToFrames(min, sec, frames)See Also
SDL::CD#closeSee Also
SDL::CD#closed?See Also
SDLはポータブルで低レベルなオーディオ出力機能を持っています。 低レベルな機能をRubyから直接利用するのは問題があるため、 Ruby/SDLでは高レベルな SDL_mixer ライブラリを経由した 音声出力機能のみ提供します。そのためオーディオ出力機能を利用するため には SDL_mixer ライブラリをインストールする必要があります。
SDL_mixer ライブラリは一般的な需要に答えるため、 単純は複数チャンネル同時演奏ができる音声ミキシング機能を提供します。 16ビットステレオが8チャンネル音声出力と、 MOD/MIDI/MP3などによる音楽演奏1チャンネルが利用可能です。
このように音声出力と音楽演奏が分けられているのは、主に実装上の 理由です。「音声出力」が効果音、「音楽演奏」がBGMと考えれば良いでしょう。 音声には SDL::Mixer::Wave クラスが、音楽には SDL::Mixer::Music クラスが対応し ています。
MIDIファイルの演奏はCPUに負荷をかけるため、普通のWAVEファイルは ちゃんと聞こえるのに、MIDIファイルを演奏するとひどい音がする ということがあります。 その場合は、8-bit出力やモノラル出力、低い周波数を試してください。
MIDIファイルを演奏するためには、 Timidity GUS Patches を適切な場所(UNIXでは /use/local/lib, Windowsでは C:\)に展開してください。
Ruby/SDL では以下の音楽/音声フォーマットが利用可能です。
現在、MP3の再生には問題があることが確認されています。 おそらくSMPEGの問題と考えられるのですが、修正されていません。 OggVorbisを代わりに使ってください。
audio関連のクラスや関数を持つモジュールです。
複数チャンネルによる合成が可能な音声データを表わすクラスです。 WAVE, AIFF, RIFF, OGG, VOC に対応しています。
音楽データを表わすクラスです。 WAVE, MOD, MIDI, OGG, MP3 に対応しています。
SDL::Mixer.open(frequency=Mixer::DEFAULT_FREQUENCY,format=Mixer::DEFAULT_FORMAT,cannels=Mixer::DEFAULT_CHANNELS,chunksize=4096)Audio関連APIの初期化をします。他のAudio関連のメソッドを呼ぶ前にこれを 呼ぶ必要があります。またこれを呼ぶ前にSDL.init(SDL::INIT_AUDIO)を呼ば なくてはなりません。 CDと同じ44.1KHzのサンプリングレートを使いたいときは frequency として 44100を与えてください。44100では古いコンピュータではCPUパワーを使いすぎる のでゲームではたいてい22050を使います。 定数 Mixer::DEFAULT_FREQUENCY はこの 22050 を表わします。 chunksize はそれぞれのチャンネルに割当てられるメモリの量(byte単位)です。 遅いコンピュータ上で chunksize を小さくすると、音が途切れる可能性が あります。また、chunksize を大きくしすぎると、効果音の発生が遅延します。 対象のコンピュータに合わせてちょうどよい値を設定してください。 単に音楽を演奏したいだけなら、4096以上にしておけば良いでしょう。 デフォルトでは8(定数Mixer::CHANNELS)チャンネルが確保されます。
format は以下のものが利用できます。
SDL::DEFAULT_FORMAT は SDL::Mixer::FORMAT_S16SYS を指します。
channels は 1 でモノラル、2でステレオ出力を指定します。 Mixer::DEFAULT_CHANNELS は 2 です。
失敗したときには例外SDL::Errorを発生させます。
EXAMPLE
# SDLを初期化、Audio機能を有効にする。 SDL.init(SDL::INIT_AUDIO) # 44.1KHz, signed 16bit, system byte order, ステレオ出力、 # 1024 byte チャンクサイズ SDL::Mixer.open(44100, SDL::Mixer::DEFAULT_FORMAT, 2, 1024)
NOTES
音の発生が遅延する場合はここで与えるパラメータを変えると 改善される場合があります。 frequency を 22050 にしたり、chunksize を2048や1024などと 小さくしたりしてみてください。format を変えるのが有効な場合もあります。
See Also
SDL::Mixer.spec初期化したデバイスが実際に使っているフォーマットを得ます。これは SDL::Mixer.open に与えたパラメータと同じ場合もありますし違う場合もあります。 返り値は [frequency, format, channels] という配列です。詳しい意味は SDL::Mixer.open を参照してください。
失敗したときには例外SDL::Errorを発生させます。
EXAMPLE
frequency, format, channels = SDL::Mixer.spec format_str = case format when SDL::Mixer::AUDIO_U8 then "U8" when SDL::Mixer::AUDIO_S8 then "S8" when SDL::Mixer::AUDIO_U16LSB then "U16LSB" when SDL::Mixer::AUDIO_S16LSB then "S16LSB" when SDL::Mixer::AUDIO_U16MSB then "U16MSB" when SDL::Mixer::AUDIO_S16MSB then "S16MSB" end printf "frequency=%dHz format=%s channels=%d", frequency, format_str, channels
See Also
SDL::Mixer.driver_nameSDL::Mixer.driverName現在使われているオーディオデバイスの名前を文字列で得ます。
SDL::Mixer.open による初期化がまだされていない場合は 例外 SDL::Error が発生します。
See Also
SDL::Mixer::Wave.load(filename)filename から音声をロードします。 WAVE, AIFF, RIFF, OGG, VOC に対応しています。
失敗したときには例外SDL::Errorを発生させます。
NOTES
これを呼ぶ前に SDL::Mixer.open を呼んでおく必要があります。
OGGをロードした場合、ロード時にすべてのデータがメモリ上にRAWデータとして 展開されるので、メモリ使用量に注意してください。
SDL::Mixer::Wave.load_from_io(io)SDL::Mixer::Wave.loadFromIO(io)ioから音声をロードします。ioにはRubyのIOオブジェクト (IO, StringIOなどread, tell, rewindを持つオブジェクト)を指定します。 WAVE, AIFF, RIFF, OGG, VOC に対応しています。
失敗したときには例外SDL::Errorを発生させます。
NOTES
これを呼ぶ前に SDL::Mixer.open を呼んでおく必要があります。
OGGをロードした場合、ロード時にすべてのデータがメモリ上にRAWデータとして 展開されるので、メモリ使用量に注意してください。
SDL::Mixer::Wave#destroySee Also
SDL::Mixer::Wave#destroyed?See Also
SDL::Mixer::Music.load(filename)filename から音楽データをロードします。 WAVE, MOD, MIDI, OGG, MP3 に対応しています。
失敗したときには例外SDL::Errorを発生させます。
NOTES
Windowsでは環境によってはMP3がロードできないことがあります。
SDL::Mixer::Music.load_from_string(str)SDL::Mixer::Music.loadFromString(str)strから音楽データをロードします。strには音楽データのバイナリ文字列 を与えます。 MOD, OGG に対応しています。
失敗したときには例外SDL::Errorを発生させます。
NOTES
内部的に str をコピーして別に保持しているため、メモリの使用量に 注意してください。
Windowsではこのメソッドが使えない場合があります。
SDL::Mixer::Music#destroySDL::Mixer::Music#destroyed?SDL::Mixer::Wave#set_volume(volume)SDL::Mixer::Wave#setVolume(volume)SDL::Mixer.allocate_channels(num_channels)SDL::Mixer.allocateChannels(num_channels)ミキシングするチャンネル数を設定します。この関数は何度呼んでもかまいません。 音声再生中に呼んでもかまいません。もし新たなチャンネル数が以前のものより 小さいならば、大きいほうのチャンネルは再生を停止し、リソースを解放し、 ミキシングされなくなります。1秒間に1000回もチャンネル数を変更させるような ことはしないほうがよいでしょう。
確保したチャンネル数を返します。
EXAMPLE
# 16チャンネル確保 SDL::Mixer.allocate_channels(16)
NOTES
もし num_channels に 0 を与えたならば、たとえ再生中でも すべてのチャンネルを解放してしまいます。
SDL::Mixer.set_volume(channel, volume)SDL::Mixer.setVolume(channel, volume)channel で指定したチャンネルのボリュームを volume に設定します。 channel に -1 を指定した場合はすべてのチャンネルのボリュームを 一度に変更します。このボリュームは最終ミキシング時に適用されるものであり、 SDL::Wave#set_volume で指定したものとは独立に作用します。つまり指定したチャンネル で再生する音をすべて半分の大きさにしたい場合は、 volume として64を指定 してください。すべてのチャンネルはデフォルトでは音量は 128、 つまり最大 の値に設定されています。SDL::Mixer.allocate_channels で新たに確保された チャンネルの音量は 128 に設定されます。そのため volume に -1 を指定して すべてのチャンネルの音量を変更した後、新たなチャンネルを確保すると、 そのチャンネルは音量変更の効果を受けません。
現在のボリュームを返します。channel として -1 を与えた場合は すべてのチャンネルの平均を返します。
SDL::Mixer.play_channel(channel, wave, loops)SDL::Mixer.playChannel(channel, wave, loops)channel で指定したチャンネルで wave で指定した音声(SDL::Mixer::Wave のインスタンス)を再生します。 channel に -1 を指定した場合は使われていない チャンネルの中で一番若いものが使われます。loops + 1 回繰り返し演奏されます。 loops に -1 を指定すると無限に繰り返します。
どのチャンネルを使って再生したかを整数で返します。
EXAMPLE
# 使われていないチャンネルを使って sample を再生する # 繰り返しはしない SDL::Mixer.play_channel(-1, sample, 0)
SDL::Mixer.play_channel_timed(channel, wave, loops, ticks)SDL::Mixer.playChannelTimed(channel, wave, loops, ticks)wave が十分長い、もしくは loops が十分大きい場合に ticks ミリ秒だけ再生します。 他は SDL::Mixer.play_channel と同じです。
EXAMPLE
# 使われていないチャンネルを使って sample を 1/2秒再生する SDL::Mixer.play_channel(-1, sample, -1, 500)
SDL::Mixer.fade_in_channel(channel, wave, loops, ms)SDL::Mixer.fadeInChannel(channel, wave, loops, ms)指定したチャンネルで音声をフェイドインして再生します。 ms ミリ秒かけてフェイドイン再生する点以外は SDL::Mixer.play_channel と 同じです。
EXAMPLE
# 使われていないチャンネルを使って # sample を1秒かけてフェードインして3回再生する SDL::Mixer.fade_in_channel(-1, sample, 2, 1000)
SDL::Mixer.fade_in_channel_timed(channel, wave, loops, ms, ticks)SDL::Mixer.fadeInChannelTimed(channel, wave, loops, ms, ticks)SDL::Mixer.pause(channel)channel で指定したチャンネルの再生を一時停止します。 channel に -1 を指定するとすべてのチャンネルを停止します。 これで一時停止したチャンネルを SDL::Mixer.halt で完全に停止してもかま いません。
EXAMPLE
# すべての音声再生を停止する SDL::Mixer.pause(-1)
See Also
SDL::Mixer.resume(channel)See Also
SDL::Mixer.halt(channel)See Also
SDL::Mixer.expire(channel, ticks)ticks ミリ秒後に、channel で指定したチャンネルの再生を停止します。 channel に -1 を与えるとすべてのチャンネルを停止します
停止するチャンネルの数を返します。
EXAMPLE
# 2秒後に全てのチャンネルの再生を停止する SDL::Mixer.expire(-1, 2000)
See Also
SDL::Mixer.fade_out(channel, ms)SDL::Mixer.fadeOut(channel, ms)この関数を呼んだ時点から ms ミリ秒かけて channel をフェードアウトします。 フェードアウトが完了したらそのチャンネルは再生を停止します。 また、channel に-1を渡すとすべてのチャンネルをフェードアウトします。 再生中のチャンネルしか影響を及ぼしませんが、一時停止中のものも 影響を受けます。
フェードアウトするチャンネルの数を返します。
EXAMPLE
# すべてのチャンネルを3秒でフェードアウトする printf "starting fade out of %d channels", SDL::Mixer.fade_out(-1, 3000)
SDL::Mixer.play?(channel)SDL::Mixer.playingChannelsSDL::Mixer.playing_channelsSDL::Mixer.pause?(channel)See Also
SDL::Mixer.fading(which)SDL::Mixer.play_music(music, loops)SDL::Mixer.playMusic(music, loops)music で指定した音楽を loop 回最初から最後まで演奏します。loops に -1 を指定すると 永遠に演奏を繰り返します。 前に演奏していていた音楽は演奏を停止します。フェードアウトの最中にある 場合はフェードアウトが終わってから次のを演奏します。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::Mixer.fade_in_music(music, loops, ms)SDL::Mixer.fadeInMusic(music, loops, ms)music で指定した音楽を ms ミリ秒かけてフェードインして演奏を開始します。 loops 回繰り返し演奏します。-1 を与えると永遠に繰り返します。 繰り返しの最初の1回目のみフェードインします。 その時点で演奏していた曲は停止します。フェードアウトの最中にある 場合はフェードアウトが終わってから次のを演奏します。
失敗したときには例外SDL::Errorを発生させます。
See Also
SDL::Mixer.set_volume_music(volume)SDL::Mixer.setVolumeMusic(volume)SDL::Mixer.pause_musicSDL::Mixer.pauseMusicSDL::Mixer.resume_musicSDL::Mixer.resumeMusicSDL::Mixer.rewind_musicSDL::Mixer.rewindMusic演奏位置を最初に移動します。音楽が演奏中、停止中、一時停止中、いずれの 場合に呼んでも問題ありません。
このモジュール関数は MOD, OGG, MP3, Native MIDI の場合のみに 使えます。
SDL::Mixer.halt_musicSDL::Mixer.haltMusicSee Also
SDL::Mixer.fade_out_music(ms)SDL::Mixer.fadeOutMusic(ms)SDL::Mixer.play_music?SDL::Mixer.playMusic?SDL::Mixer.pause_music?SDL::Mixer.pauseMusic?SDL::Mixer.fading_musicSDL::Mixer.fadingMusicDLは時間を扱うクロスプラットフォームな方法をいくつか提供しています。 提供しているものは現在の時間を得る方法と短時間待つ方法です。
SDL.get_ticksSDL.getTicksSee Also
SDL.delay(ms)NOTES
少くとも10ミリ秒の遅延を考えて下さい。 プラットフォームによってはもっと短かい時間の場合もありますが、 この値が最も一般的です。
この関数を使って停止している間は Ruby のスレッドは切り替わりません。 同等のことは Kernel#sleep で実現可能であるので、そちらを使ってください。
Ruby/SDL は3種類の異なるフォント描画システムを持っています。 SDL_ttf での True Type Font の描画、 SGE での独自形式/SFont形式でのビットマップフォントの描画、 SDL_kanji での bdf フォントの描画 です。 このそれぞれに、SDL::TTF、SDL::BMFont、SDL::Kanji というクラスが割当てられて いて、それぞれ異なるメソッド、機能を持ちます。
これにはそれぞれ以下のような特徴があります。適切に使いわけてください。
SDL::TTF
フォントファイルの名前は *.ttf や *.ttc が一般的です。 フォントデータの情報がベクトルデータであるため、一つの フォントデータがあれば任意の大きさの文字を描画できる利点があります。 フォントデータを準備するのが面倒という欠点です。とくに自作 するのは大変でしょう。
SDL::BMFont
フォントファイルはたんなるビットマップファイル(*.bmp) や PNG ファイル(*.png) を使います。独自形式の場合、画像を等幅の文字データを横に256個並べたものと みなし、そのそれぞれが ASCII コードと対応しているもとの解釈されます。 つまり 横幅 8 ピクセル、高さ 16ピクセルのデータならば 幅 8*256 = 2048、高さ 16ピクセルの画像となります。 フォントデータを自作するのが比較的容易なことが利点です。 平仮名、漢字等の描画ができないこと、拡大縮小した文字を 描画できないことが欠点です。
もう一つ、このクラスは SFont 形式も扱うことができます。これもビットマップフォントの一種ですが、 文字の幅が可変である点などが利点です。詳しくはリンク先を見てください。
SDL::Kanji
フォントファイルの拡張子にはbdfが使われます。ビットマップフォントの 一種です。複数のフォントファイル(例えばアルファベットと日本語) のデータを併せて使う機能を持っています。 平仮名、漢字等の描画が可能な点が利点です。 欠点は、bdf フォントはあまり一般的な形式ではないためフォントの用意が 面倒であることです。
TrueTypeFontを表わすクラスです。このクラスを使うためには、 SDL_ttf が必要です。バックエンドにFreetype を利用します。
また、フォントのライセンスにも注意してください。例えば Windows 付属の フォントは再配布が認められていません。
ビットマップフォントを表わすクラスです。このクラスを使うためには SGE が必要です。
bdfフォントを表わすクラスです。
SDL::TTF.initTTF描画機能を初期化します。 SDL::TTF の他のメソッドを呼ぶ前にこれを呼んでください。 SDL.init を呼ぶ前に呼んでもかまいません。
このメソッドを使うには SDL_ttf が必要です。
See Also
SDL::TTF.init?TTF描画機能が既に初期化されていればtrueを、いなければ falseを返します。
このメソッドを使うには SDL_ttf が必要です。
See Also
SDL::TTF.open(filename, ptsize, index=nil)filename で指定したフォントファイルを ptsize ポイント で読み込みます。index で face index を指定できます。 デフォルトでは 0 です。
SDL::TTF のインスタンスを返します。
失敗したときには例外SDL::Errorを発生させます。
このメソッドを使うには SDL_ttf が必要です。
EXAMPLE
SDL::TTF.init
font = SDL::TTF.open("font.ttf", 32, 0)SDL::TTF#closeフォントをクローズし、関連するリソースを解放します。
このメソッドを使うには SDL_ttf が必要です。
See Also
SDL::TTF#closed?フォントがSDL::TTF#closeでクローズされたかどうかを 返します。
このメソッドを使うには SDL_ttf が必要です。
See Also
SDL::TTF#styleフォント self の描画スタイルを以下の値の論理和をとったもので返します。
以上のどれも設定されていない場合は SDL::TTF::STYLE_NORMAL が返されます。
このメソッドを使うには SDL_ttf が必要です。
EXAMPLE
print "The font style is:" print " normal" if font.style == SDL::TTF::STYLE_NORMAL print " bold" if (font.style & SDL::TTF::STYLE_BOLD) != 0 print " italic" if (font.style & SDL::TTF::STYLE_ITALIC) != 0 print " italic" if (font.style & SDL::TTF::STYLE_UNDERLINE) != 0 print "\n"
See Also
SDL::TTF#style=(new_style)フォント self の描画スタイルを new_style に設定します。 new_style は以下の定数の論理和を与えてください。
このメソッドを使うには SDL_ttf が必要です。
EXAMPLE
# イタリック体かつボールド体に設定する font.style = SDL::TTF::STYLE_ITALIC | SDL::TTF::STYLE_BOLD # 描画する… # 通常に戻す font.style = SDL::TTF::STYLE_NORMAL
NOTES
このメソッドを呼ぶと内部のレンダリング済み文字のキャッシュが 消されます。
See Also
SDL::TTF#heightフォントの文字の中で一番縦の高さが高いものの高さをピクセル数で返します。 この値を文字を縦にできるだけ近づけて描画するために使えます。その場合は この値に1を足せば文字同士が触れなくなります。 Ruby/SDLは複数行描画を考慮していないため、行間をきちんと取るのは 自分でしなければなりません。SDL::TTF#line_skip も参考にしてください。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#ascent文字のascent(ベースラインからの上の部分の高さ)の最大値を返します。 つまり文字の上端からベースラインまでの距離です。
このメソッドを使うには SDL_ttf が必要です。
See Also
SDL::TTF#descent文字のdescent(ベースラインから下の部分の高さ)の最大値を返します。 つまり文字の下端からベースラインまでの距離です。
このメソッドを使うには SDL_ttf が必要です。
See Also
SDL::TTF#line_skipそのフォントに一行あたり何ピクセルの高さを割当てるべきかを 返します。複数行描画したい場合には SDL::TTF#height の値より こちらの値を使ったほうが良いかもしれません。 この値は通常 SDL::TTF#height の値より大きいです。
このメソッドを使うには SDL_ttf が必要です。
See Also
SDL::TTF#facesフォントに含まれる利用可能なフェイス(「サブフォント」)の数を返します。 通常この値は利用価値はないでしょう、というのはこの値は SDL::TTF の他の メソッドになんら影響を与えないからです。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#fixed_width?self が等幅であれば true を、なければ false を返す。 等幅フォントはすべての文字が同じであり、文字列をレンダリングした結果 のサーフェスの幅は単に「文字の幅 * 文字列の長さ」になります。
このメソッドを使うには SDL_ttf が必要です。
See Also
SDL::TTF#family_nameSDL::TTF#familyNameself の現在のフォントフェイスの名前を返します。 名前情報が無い場合は nil を返します。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#style_nameSDL::TTF#styleNameself の現在のフォントフェイスのスタイルの名前を返します。 名前情報が無い場合は nil を返します。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#text_size(text)SDL::TTF#textSize(text)text で与えられた文字列をレンダリングするのに必要なサーフェス のサイズを計算し、その幅、高さを返します。text のエンコーディングは UTF8でなければなりません。 実際には一切レンダリングされませんが、カーニングの影響を考慮した幅が 得られます。 高さは SDL::TTF#height と同じ値が得られます。
失敗したときには例外SDL::Errorを発生させます。
このメソッドを使うには SDL_ttf が必要です。
EXAMPLE
w, h = font.size_text("Hello World!")
puts "width=#{w} height=#{h}"
SDL::TTF#render_solid_utf8(text, r, g, b)SDL::TTF#renderSolidUTF8(text, r, g, b)text で指定した文字列(エンコーディングはUTF8)を r, [g], b で指定した色でレンダリングし、結果を SDL::Surface のインスタンスで返します。
SDL::TTF#render_shaded_utf8 や SDL::TTF#render_blended_utf8 より高速ですが見た目はこれらより良くありません。
生成されるサーフェスは8bppのサーフェスで、指定した色 および透明色の2色のみ使われます。 透明色として 0 のピクセル値が、 文字の部分に 1 のピクセル値が 使われ、パレットの1に指定した色の値が置かれます。 そのため再レンダリングすることなしに文字の色を変えることができます。 0 はカラーキーで、透明ですから、 パレット 0 の色は当然他のサーフェスに転送しても 描画されません。実はこの色は (255-r, 255-g, 255-b) です。 これは SDL::TTF#render_shaded_utf8 や SDL::TTF#render_blended_utf8 に比べて高速なレンダリングができますが、 アンチエイリアシング等はかかっていません。 また、このメソッドで作ったサーフェスは、 TTF#render_blended_utf8] で生成したサーフェスを @[転送 するより高速に転送できます。 とにかく高速な動作が必要な場合に使うとよいでしょう。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#render_shaded_utf8(text,fg_r,fg_g,fg_b,bg_r,bg_g,bg_b)SDL::TTF#renderShadedUTF8(text,fg_r,fg_g,fg_b,bg_r,bg_g,bg_b)text で指定した文字列(エンコーディングはUTF8)を fg_r, [fg_g], fg_b で指定した色を文字の色、 bg_r, [bg_g], bg_b で指定した色を背景の色として レンダリングし、結果を SDL::Surface のインスタンスで返します。
SDL::TTF#render_solid_utf8よりレンダリングは低速ですが、 見た目は SDL::TTF#render_solid_utf8 より優れています。
生成されるサーフェスは8bppで、ピクセル値 0 が背景で、 その他のピクセル値は背景色と前景色との中間の色を表現するため に使われます。文字にはアンチエイリアスがされています。 レンダリングの速度は SDL::TTF#render_solid_utf8 より低速で、 SDL::TTF#render_blended_utf8 と同じくらいです。 また、このメソッドで作ったサーフェスは、 TTF#render_solid_utf8] で生成したサーフェスを@[転送 するのと同じくらいの速度で転送できます。 カラーキーによる抜きやアルファブレンドなどは仕組み上使えないので、 高品質なレンダリングが必要で、背景が一色で問題ない場合に使ってください。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#render_blended_utf8(text, r, g, b)SDL::TTF#render_blended_utf8(text, r, g, b)text で指定した文字列(エンコーディングはUTF8)を r, [g], b で指定した色でレンダリングし、結果を SDL::Surface のインスタンスで返します。
SDL::TTF#render_solid_utf8よりレンダリングは低速ですが、 見た目は優れています。
生成されるサーフェスは32bppARGBのもので、アルファを使いディザリング をし高品質な文字描画をします。背景はアルファ値が完全に透明な値なので、 SDL::TTF#render_shaded_utf8 のように文字のまわりに四角が描かれる ことはありません。文字にはアンチエイリアシングがされています。 レンダリングに必要な時間は SDL::TTF#render_solid_utf8 より長く、 SDL::TTF#render_shaded_utf8 と同じくらいです。 また、生成したサーフェスを blit 転送するのには、 SDL::TTF#render_solid_utf8 や SDL::TTF#render_shaded_utf8 で生成した サーフェスを転送するより時間がかかります。 このメソッドは高品質なレンダリングが必要で、速度がそれほど必要と されない場合に利用してください。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#draw_solid_utf8(dest, text, x, y, r, g, b)SDL::TTF#drawSolidUTF8(dest, text, x, y, r, g, b)text で指定した文字列を dest で指定したサーフェスの (x, y) を左上とした場所に(r, g, b)で指定した色で 描画します。描画される文字の品質や速度などは SDL::TTF#render_solid_utf8 と同じ特性を持ちます。詳しくはそちらを見てください。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#draw_shaded_utf8(dest, text, x, y, fg_r, fg_g, fg_b, bg_r, bg_g, bg_b)SDL::TTF#drawShadedUTF8(dest, text, x, y, fg_r, fg_g, fg_b, bg_r, bg_g, bg_b)text で指定した文字列を dest で指定したサーフェスの (x, y) を左上とした場所に(fg_r, fg_g, fg_b)で指定した 色で文字を、(bg_r, bg_g, bg_b)で指定した色を背景として 描画します。描画される文字の品質や速度などは SDL::TTF#render_shaded_utf8 と同じ特性を持ちます。そのため(x, y)を左上とし、 SDL::TTF#size_text(text) を幅、高さとする長方形が指定した背景色で 塗りつぶされます。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#draw_blended_utf8(dest, text, x, y, r, g, b)SDL::TTF#drawBlendedUTF8(dest, text, x, y, r, g, b)text で指定した文字列を dest で指定したサーフェスの (x, y) を左上とした場所に(r, g, b)で指定した色で 描画します。描画される文字の品質や速度などは SDL::TTF#render_blended_utf8 と同じ特性を持ちます。詳しくはそちらを見てください。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#render_solid(text, r, g, b)SDL::TTF#renderSolid(text, r, g, b)textがUTF8でなくても良いこと以外、 SDL::TTF#render_solid_utf8と同じです。 textのエンコードは適切に変換されます。
このメソッドはRuby 1.9でRuby/SDLのm17n機能を有効にしている 場合にのみ利用できます。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#render_shaded(text, r, g, b)SDL::TTF#renderShaded(text, r, g, b)textがUTF8でなくても良いこと以外、 SDL::TTF#render_shaded_utf8と同じです。 textのエンコードは適切に変換されます。
このメソッドはRuby 1.9でRuby/SDLのm17n機能を有効にしている 場合にのみ利用できます。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#render_blended(text, r, g, b)SDL::TTF#renderBlended(text, r, g, b)textがUTF8でなくても良いこと以外、 SDL::TTF#render_blended_utf8と同じです。 textのエンコードは適切に変換されます。
このメソッドはRuby 1.9でRuby/SDLのm17n機能を有効にしている 場合にのみ利用できます。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#draw_solid(dest, text, r, g, b)SDL::TTF#drawSolid(dest, text, r, g, b)textがUTF8でなくても良いこと以外、 SDL::TTF#draw_solid_utf8と同じです。 textのエンコードは適切に変換されます。
このメソッドはRuby 1.9でRuby/SDLのm17n機能を有効にしている 場合にのみ利用できます。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#draw_shaded(dest, text, r, g, b)SDL::TTF#drawShaded(dest, text, r, g, b)textがUTF8でなくても良いこと以外、 SDL::TTF#draw_shaded_utf8と同じです。 textのエンコードは適切に変換されます。
このメソッドはRuby 1.9でRuby/SDLのm17n機能を有効にしている 場合にのみ利用できます。
このメソッドを使うには SDL_ttf が必要です。
SDL::TTF#draw_blended(dest, text, r, g, b)SDL::TTF#drawBlended(dest, text, r, g, b)textがUTF8でなくても良いこと以外、 SDL::TTF#draw_blended_utf8と同じです。 textのエンコードは適切に変換されます。
このメソッドはRuby 1.9でRuby/SDLのm17n機能を有効にしている 場合にのみ利用できます。
このメソッドを使うには SDL_ttf が必要です。
SDL::BMFont.open(filename, flags)filename で指定したフォントをロードし、そのフォントを表わす オブジェクトを SDL::BMFont のインスタンスとして返します。
flags としては以下の値を与えることができます。
このメソッドを使うには SGE が必要です。
SDL::BMFont#closeビットマップフォントを閉じ、確保しているリソースを解放します。
このメソッドを使うには SGE が必要です。
See Also
SDL::BMFont#closed?ビットマップフォントがSDL::BMFont#closeによって閉じられたか どうかを返します。
このメソッドを使うには SGE が必要です。
See Also
SDL::BMFont#set_color(r, g, b)SDL::BMFont#setColor(r, g, b)フォントの色を (r, g, b) に変更します。多色フォントおよび SFontに対しては利用できません。このメソッドを何度も呼ぶのであれば SDL::BMFont.open で SDL::BMFont::PALETTE を与えておくと良いでしょう。
このメソッドを使うには SGE が必要です。
SDL::BMFont#heightフォントの高さを返します。
このメソッドを使うには SGE が必要です。
See Also
SDL::BMFont#width文字一つ分の幅を返します。SFont に対しては使えません。
このメソッドを使うには SGE が必要です。
See Also
SDL::BMFont#text_size(string)SDL::BMFont#textSize(string)self で表わされるフォントで string を描画するのに必要な サーフェスの大きさを [幅, 高さ] という配列で返します。 長さの単位はピクセル数です。
このメソッドを使うには SGE が必要です。
See Also
SDL::BMFont#textout(surface, string, x, y)string を surface の (x, y) に描画します。
このメソッドを使うには SGE が必要です。
See Also
SDL::Kanji.open(filename, size)See Also
SDL::Kanji#closeSee Also
SDL::Kanji#closed?See Also
SDL::Kanji#add(filename)See Also
SDL::Kanji#set_coding_system(sys)SDL::Kanji#setCodingSystem(sys)文字コードを指定します。 sys として以下のいずれかを指定できます。
デフォルトでは SDL::Kanji::JIS が指定されています。
SDL::Kanji#get_coding_systemSDL::Kanji#getCodingSystem既定の文字コード返します。 返り値は以下のいずれかです。
デフォルトでは SDL::Kanji::JIS が指定されています。
SDL::Kanji#heightSDL::Kanji#textwidth(text)See Also
SDL::Kanji#widthSee Also
SDL::Kanji#put(surface, text, x, y, r, g, b)NOTES
Ruby 1.9ではRuby/SDLのm17n機能を有効にしている限り 必要に応じてエンコーディングの自動変換を行います。
See Also
SDL::Kanji#put_tate(surface, x, y, r, g, b)SDL::Kanji#putTate(surface, x, y, r, g, b)text で指定した文字列を surface の (x, y) に (r, g, b) で指定した色で縦書きで描画します。
ASCII文字は縦書きにできません。
NOTES
Ruby 1.9ではRuby/SDLのm17n機能を有効にしている限り 必要に応じてエンコーディングの自動変換を行います。
See Also
Ruby/SDL には SGE 由来の衝突判定システムがあります。 基本的な仕組みは、判定のある部分と無い部分の2値の長方形画像を生成し、 それを2つ持ってきて、重なっている部分を1ピクセルずつ見ていくことで その2つが衝突しているか、つまり重なっているかどうかを判定します。
sample/collision.rb も参考にしてください。
衝突判定のための2値画像を表わすクラスです。 SDL::Surface#make_collision_map によってのみインスタンスが作れます。
SDL::Surface#make_collision_mapSDL::Surface#makeCollisionMapSDL::Surface のインスタンスから SDL::CollisionMap を生成します。 self のピクセルのうちカラーキーで透明ピクセルになっている 所が衝突しない所、そうでないピクセルが衝突するピクセルになります。
失敗したときには例外SDL::Errorを発生させます。
このメソッドを使うには SGE が必要です。
SDL::CollisionMap#collision_check(x1, y1, cmap, x2, y2)self の左上が 座標 (x1, y1)、もうひとつの SDL::CollisionMap のインスタンス cmap の左上が (x2, y2)に ある場合に、この2つが重なっているかどうかを判定し、重なっている なら true を、いないなら false を返します。
このメソッドは内部で SDL::CollisionMap#bounding_box_check を 呼んでいます。
このメソッドを使うには SGE が必要です。
See Also
SDL::CollisionMap.bounding_box_check(x1,y1,w1,h1,x2,y2,w2,h2)SDL::CollisionMap.boundingBoxCheck(x1,y1,w1,h1,x2,y2,w2,h2)左上が(x1,y1)、幅w1高さh1の長方形と 左上が(x2,y2)、幅w2高さh2の長方形が 重なっているかどうかを判定します。
長方形が重なっていれば true を、いなければ false を返します。
このメソッドを使うには SGE が必要です。
See Also
SDL::CollisionMap#bounding_box_check(x1, y1, cmap, x2, y2)SDL::CollisionMap#boundingBoxCheck(x1, y1, cmap, x2, y2)SDL::CollisionMap のインスタンスを長方形と見なし、 self の左上が (x1, y1)、cmap の左上の点が (x2, y2)に あるとして2つの長方形が重なっているかどうかを判定します。
長方形が重なっていれば true を、いなければ false を返します。
このメソッドを使うには SGE が必要です。
SDL::CollisionMap#clear(x, y, w, h)引数で指定した長方形を衝突なしの状態にします。
このメソッドを使うには SGE が必要です。
See Also
SDL::CollisionMap#set(x, y, w, h)引数で指定した長方形を衝突ありの状態にします。
このメソッドを使うには SGE が必要です。
See Also
SDL::CollisionMap#w衝突判定用画像の幅を返します。
このメソッドを使うには SGE が必要です。
See Also
SDL::CollisionMap#h衝突判定用画像の高さを返します。
このメソッドを使うには SGE が必要です。
See Also
Ruby/SDL には SDLSKK を利用した SKK に似た日本語入力システムがあります。
これは日本語入力ができるだけでなく、 カット&ペーストを含む簡単な行編集機能を持っています。
sample/sdlskk.rb も参考にしてください。
SDLSKK関連のモジュール関数およびクラスを持つモジュールです。
入力の状態などを表わすクラスで、SDL::SKKの中心的なクラスです。
辞書を表わすクラスです。ファイルから SKK 形式の辞書を読み込むこと ができます。
入力のキーバインドを表わすクラスです。
ローマ字 -> 仮名 の変換テーブルを表わすクラスです。 この変換テーブルは、SDLSKK独自の形式のテキストファイルで、 それを読み込んでインスタンスを生成します。
変換テーブルファイルは SDLSKK に付属しています。
SDL::SKK.encoding=(encoding)SDLSKK内部のエンコーディングを encoding に指定します。
のいずれかを指定してください。SDL::SKK::EUCJP がデフォルトです。 また、これはSDLSKK関連の他のメソッドを呼ぶ前に呼んでください。
これは、SDL::SKK::Dictionary#loadとSDL::SKK::RomKanaRuleTable.newで 読み込むファイルおよび SDL::SKK::Context#str で得られる文字列、 SDL::SKK::Dictionary#save で書き出すファイルの エンコードを決定します。
このメソッドを使うには SDLSKK が必要です。
NOTES
このモジュール関数は最初に1回だけ呼んでください。 途中でエンコーディングを変更すると正しく動作しません。
See Also
SDL::SKK.encoding, SDL::SKK::Dictionary#load, SDL::SKK::Dictionary#save, SDL::SKK::RomKanaRuleTable.new
SDL::SKK.encodingSDLSKKの内部エンコーディングを返します。詳しくは SDL::SKK.encoding= を 見てください。
このメソッドを使うには SDLSKK が必要です。
See Also
SDL::SKK::RomKanaRuleTable.new(filename)filenameで指定したファイルをアルファベットからかなへの変換テーブル として読み込みます。 ファイルの形式は以下の通りです。
それ以外の行は1行1エントリーで、以下のような形式
入力アルファベット<TAB>かな変換後に残るアルファベット<TAB>片仮名<TAB>平仮名
このメソッドを使うには SDLSKK が必要です。
NOTES
このファイルのエンコーディングは SDL::SKK.encoding= であらかじめ指定しておいて ください。
See Also
SDL::SKK::Dictionary.new空の辞書として SDL::SKK::Dictionary のインスタンスを生成します。 適当な辞書をこれに読み込んでください。
このメソッドを使うには SDLSKK が必要です。
See Also
SDL::SKK::Dictionary#load(filename, user)filename で指定した辞書を読み込みます。辞書の形式は SKK のものと 同一です(ただしannotationを含むものは不可です)。 user を真にすると その辞書はユーザ辞書であると扱われ、そこに含まれる エントリーすべてにユーザ入力マークが付きます。
ユーザ入力マークが付いたエントリーのみが SDL::SKK::Dictionary#save で ユーザ辞書に出力されます。
失敗したときには例外SDL::Errorを発生させます。
このメソッドを使うには SDLSKK が必要です。
NOTES
このファイルのエンコーディングは SDL::SKK.encoding= であらかじめ指定しておいて ください。
See Also
SDL::SKK::Dictionary.new, SDL::SKK::Dictionary#save, SDL::SKK::Context.new
SDL::SKK::Dictionary#save(filename)filename で指定したファイルにユーザ辞書を出力します。 ユーザが利用した変換と、 SDL::SKK::Dictionary#load で「ユーザ辞書」として読み込まれた 項とをあわせたものを、ユーザ辞書として扱います。
このメソッドを使うには SDLSKK が必要です。
SDL::SKK::Keybind.new空のキーバインドに対応する SDL::SKK::Keybind のインスタンスを返します。 これに SDL::SKK::Keybind#set_key や SDL::SKK::Keybind#set_default_key などを使ってキーバインドを追加して使います。
このメソッドを使うには SDLSKK が必要です。
SDL::SKK::Keybind#set_key(key_str, cmd_str)key_str に設定したいキーを示す文字列を、cmd_str に設定したい 動作を示す文字列を与え、キーバインドを設定します。
key_str としては以下のような文字列を与えることができます。
_ また、cmd_str には以下の文字列を与えることができます。
ただし、"a" や "/" といったアスキー文字1文字のキーにはデフォルト 以外のキーバインドはしないようにしてください。
標準のキーバインドを少し変更したいという場合は、まず SDL::SKK::Keybind#set_default_key を呼んで、デフォルトのキーバインドを 設定してからこのメソッドを呼んでください
このメソッドを使うには SDLSKK が必要です。
SDL::SKK::Keybind#set_default_keyEmacsに似た標準的なキーバインドを設定します。
このメソッドを使うには SDLSKK が必要です。
See Also
SDL::SKK::Keybind#unset_key(key_str)key_str で指定したキーのキーバインドを無効にします。 key_str には SDL::SKK::Keybind#set_key と同じ値を使います。
このメソッドを使うには SDLSKK が必要です。
SDL::SKK::Context.new(dict, romkama_table, bind, use_minibuffer)入力コンテキストを生成し、SDL::SKK::Context のインスタンスを返します。 dict は利用する辞書として SDL::SKK::Dictionary のインスタンスを、 romkama_table はローマ字かな変換規則として SDL::SKK::RomKanaRuleTable のインスタンスを、bind にはキーバインドとして SDL::SKK::Keybind のインスタンス を与える。 use_minibuffer に真値を与えるとミニバッファを利用するようになります。 偽では利用しません。
このメソッドを使うには SDLSKK が必要です。
EXAMPLE
# 辞書を生成し、ファイルから辞書データを読み込む dict = SDL::SKK::Dictionary.new dict.load( 'jisyo', false ) # ローマ字仮名変換テーブルを読み込む table = SDL::SKK::RomKanaRuleTable.new( 'rule_table' ) # キーバインドを設定する bind = SDL::SKK::Keybind.new bind.set_default_key # コンテキストを生成 context = SDL::SKK::Context.new( dict, table, bind, use_minibuffer )
See Also
SDL::SKK::Context#input(event)イベント経由でキーボードからの入力を受け付け、 コンテキストの状態を変更します。 event には SDL::Event のインスタンスを与えます。 SDL::Event::KeyDown 以外のイベントは無視します。
このメソッドを使うには SDLSKK が必要です。
EXAMPLE
while event = SDL::Event.poll do
case event
when SDL::Event::Quit
exit
when SDL::Event::KeyDown
if event.sym == SDL::Key::ESCAPE then
exit
end
if event.sym == SDL::Key::F1
dict.save("test_user_dict")
end
context.input( event )
end
endSDL::SKK::Context#str入力途中の文字列を返します。
NOTE Ruby 1.9ではRuby/SDLのm17n機能を有効にしている限り、 返り値の文字列に適切なエンコーディングを付加します。
このメソッドを使うには SDLSKK が必要です。
SDL::SKK::Context#render_str(font, r, g, b)self が持っている入力途中の文字列をレンダリングして SDL::Surface のインスタンスを返します。 font はレンダリングに利用するフォントを SDL::TTF のインスタンスで与え、 その色を (r, g, b) で指定します。
このメソッドを使うには SDLSKK が必要です。
SDL::SKK::Context#render_minibuffer_str(font, r, g, b)self が持っている入力途中のミニバッファの状態をレンダリングして SDL::Surface のインスタンスを返します。 font はレンダリングに利用するフォントを SDL::TTF のインスタンスで与え、 その色を (r, g, b) で指定します。
このメソッドを使うには SDLSKK が必要です。
SDL::SKK::Context#clear入力文字列と入力状態をクリアして初期状態に戻します。
このメソッドを使うには SDLSKK が必要です。
See Also
SDL::SKK::Context#clear_textself の入力モードが、確定入力モード、アルファベット入力モード、 JISX0208アルファベット入力モードのいずれかであればそのモードを 維持したまま入力テキストを空にします。
複数行の入力を実現したい場合、SDL::SKK::Context を呼ぶと モードが確定入力モードに戻ってしまうのが不自然である場合、 この関数を呼ぶとよいでしょう。
また、カットバッファの内容も保存されます。
このメソッドを使うには SDLSKK が必要です。
See Also
SDL::SKK::Context#get_basic_modeself の入力モードが、確定入力モード、アルファベット入力モード、 JISX0208アルファベット入力モードのいずれかであれば真を、それ 以外では偽を返す。辞書登録モードのときなども偽を返します。
これが真のときにリターンキーを押したら入力終了とみなす、 などといった処理に利用します。
このメソッドを使うには SDLSKK が必要です。
NOTES
入力モードの名前やその内容については SKK のマニュアルなどを参考にしてください。
See Also
Ruby/SDLはMPEGの映像および音声を SMPEG を利用して再生することができます。
これを利用するためには、初期化時に SDL.init の引数として SDL::INIT_AUDIO|SDL::INIT_VIDEO を与え、さらにその後 SDL::Mixer.open を呼ぶ必要があります。
また、この機能は内部では OS ネイティブのスレッド機能を使い、 別スレッドで再生ルーチンを呼ぶことで実現されています。 そのため再生中は再生映像が描画されている サーフェス にアクセスしてはなりません。 もう一つ、 SDL_Mixer の音声再生機能をフックしているため 音声を伴う再生、つまり SDL::MPEG#enable_audio を真にして SDL::MPEG#play を呼びだした場合にはその再生中には SDL::Mixer での音声再生はできません。
これらの制限に対しては、一切のチェックを Ruby/SDL では行って いません。よって MPEG 再生機能を使う場合には以上のことに 注意してください。
MPEGストリームを表わすクラスです。再生状態もこのクラスが 保持します。
SDL::MPEG の情報を表わすクラスです。SDL::MPEG#info でインスタンスが 得られます。
SDL::MPEG.new(filename)SDL::MPEG.load(filename)filename で指定したMPEGファイルを読み込み、 SDL::MPEG の新しいインスタンスを返します。
失敗したときには例外SDL::Errorを発生させます。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#infoMPEGオブジェクトの現在の状態を SDL::MPEG::Info のインスタンスで返します。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#enable_audio(enable)SDL::MPEG#enableAudio(enable)self を再生するときに音声を再生するかどうかを指定します。 enable に true を与えると再生し、false を与えると再生 しないように設定します。これを使い映像のみを再生することができます。
このメソッドを使うには SMPEG が必要です。
NOTES
このメソッドは演奏中に呼びだしても効果を発揮しません。一度演奏を 停止し、再び演奏を開始して始めてこの指定が有効になります。
See Also
SDL::MPEG#enable_video(enable)SDL::MPEG#enableVideo(enable)self を再生するときに映像を再生するかどうかを指定します。 enable に true を与えると再生し、false を与えると再生 しないように設定します。これを使い音声のみを再生することが できます。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#statusself の現在の状態を以下の3種類の値で返します。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#set_volume(volume)SDL::MPEG#setVolume(volume)MPEG音声のボリュームを0から100までの値で指定します。
このメソッドを使うには SMPEG が必要です。
NOTES
現在設定されているボリュームの大きさを得る方法はありません。
See Also
SDL::MPEG#set_display(surface)SDL::MPEG#setDisplay(surface)再生された映像を描画するサーフェスを設定します。これには通常 SDL.set_video_mode で得たサーフェスを与えます。
このメソッドを使うには SMPEG が必要です。
NOTES
これで指定したサーフェスは再生時に自動で SDL::Screen#update_rect が 呼ばれます。
See Also
SDL::MPEG#set_loop(repeat)SDL::MPEG#setLoop(repeat)再生をループするかどうかを指定します。。 repeat に true/false を与えるとループする/しないとなります。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#scale_xy(width, height)SDL::MPEG#scaleXY(width, height)再生する映像の大きさを横 width ピクセル、縦 height ピクセルに指定します。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#scale(scale)再生する画像の大きさを縦横 scale 倍にします。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#move(x, y)再生画像の描画位置を SDL::MPEG#set_display で指定した描画先サーフェスの (x, y) に指定します。
このメソッドを使うには SMPEG が必要です。
SDL::MPEG#set_display_region(x, y, w, h)映像が描画される位置を(x, y)、大きさを(w, h) にします。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#playMPEGを再生します。
このメソッドを使うには SMPEG が必要です。
NOTES
再生中は SDL::MPEG#set_display で指定したサーフェスには 触れないでください。
See Also
SDL::MPEG#pause, SDL::MPEG#stop, SDL::MPEG#rewind, SDL::MPEG#seek, SDL::MPEG#skip, SDL::MPEG#render_frame
SDL::MPEG#stopMPEGの再生を停止します。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#pauseMPEGの再生中にを一時停止/再開します。再生中なら一時停止、 一時停止中なら再開します。
このメソッドを使うには SMPEG が必要です。
SDL::MPEG#rewindMPEGの再生位置を最初に移動します。
このメソッドを使うには SMPEG が必要です。
SDL::MPEG#seek(bytes)MPEGの再生位置を bytes バイト シークします。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#skip(seconds)MPEGの再生位置を seconds 秒進めます。 seconds には Float が指定できます。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#render_frame(framenum)MPEGの中の framenum で指定したフレームを SDL::MPEG#set_display で指定した サーフェスの SDL::MPEG#move で指定した位置に描画します。
このメソッドを使うには SMPEG が必要です。
See Also
SDL::MPEG#render_final(dst, x, y)MPEGの映像の最後のフレームを dst で指定したサーフェスの (x, y)の位置に描画します。
このメソッドを使うには SMPEG が必要です。
SDL::MPEG#set_filer(filter)映像にかけるフィルタを以下の中から指定します。
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#has_audioMPEGストリームが音声を持っているかを true/false で返します。
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#has_videoMPEGストリームが映像を持っているかを true/false で返します。
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#width映像の幅をピクセル数で返します。
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#height映像の高さをピクセル数で返します。
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#current_framenot documented yet
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#current_fpsnot documented yet
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#audio_stringnot documented yet
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#audio_current_framenot documented yet
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#current_offsetnot documented yet
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#total_sizenot documented yet
このメソッドを使うには SMPEG が必要です。
SDL::MPEG::Info#current_timenot documented yet
このメソッドを使うには SMPEG が必要です。
SDL::MPEG#total_timenot documented yet
このメソッドを使うには SMPEG が必要です。
SDL::MPEG#deletenot documented yet
このメソッドを使うには SMPEG が必要です。
SDL::MPEG#deleted?not documented yet
このメソッドを使うには SMPEG が必要です。