rubysdl 2.1.0 → 2.1.1
Sign up to get free protection for your applications and to get access to all the features.
- data/MANIFEST +2 -4
- data/NEWS.en +13 -0
- data/NEWS.ja +13 -0
- data/README.en +5 -12
- data/README.ja +4 -11
- data/doc-en/collision.rsd +26 -0
- data/doc-en/event.rsd +1 -1
- data/doc-en/mpeg.rsd +2 -2
- data/doc-en/opengl.rsd +1 -1
- data/doc-en/video.rsd +7 -7
- data/doc/collision.rsd +24 -0
- data/doc/event.rsd +1 -1
- data/doc/mpeg.rsd +2 -2
- data/doc/video.rsd +45 -11
- data/extconf.rb +6 -1
- data/lib/rubysdl_compatible_ver1.rb +5 -3
- data/lib/sdl.rb +2 -2
- data/rubysdl_event.c +2 -2
- data/rubysdl_main.c +1 -1
- data/rubysdl_mixer.c +3 -0
- data/rubysdl_ref.en.html +2191 -1982
- data/rubysdl_ref.en.rd +273 -24
- data/rubysdl_ref.html +2300 -2007
- data/rubysdl_ref.rd +380 -23
- data/rubysdl_smpeg.c +1 -1
- data/sample/testgl.rb +96 -93
- data/sample/testgl_old.rb +166 -0
- metadata +10 -10
- data/rubysdl_const_list.txt +0 -280
- data/rubysdl_doc_old.en.rd +0 -2181
- data/rubysdl_doc_old.rd +0 -2402
data/rubysdl_ref.en.rd
CHANGED
@@ -33,6 +33,20 @@ Ruby/SDL has following functions.
|
|
33
33
|
* ((<MPEG playback>)) with ((<SMPGE|URL:http://www.icculus.org/smpeg/>))
|
34
34
|
* ((<Window Management>)) and ((<Collision Detection>))
|
35
35
|
|
36
|
+
= m17n on Ruby 1.9
|
37
|
+
On ruby 1.9, strings have encoding information
|
38
|
+
but many methods of Ruby/SDL ignore this information
|
39
|
+
since SDL doesn't define the treatment of multibyte
|
40
|
+
encodings.
|
41
|
+
Only some methods use encoding information such as
|
42
|
+
((<SDL::WM.set_caption>)) and ((<SDL::Kanji#put>)).
|
43
|
+
|
44
|
+
Please see items in this reference for more details.
|
45
|
+
|
46
|
+
You can enable/disable Ruby/SDL m17n support
|
47
|
+
to use --enable-m17n/--disable-m17n when you
|
48
|
+
run extconf.rb.
|
49
|
+
|
36
50
|
== SDL::Error
|
37
51
|
A Exception class for SDL specific errors.
|
38
52
|
This class is subclass of StandardError.
|
@@ -63,11 +77,11 @@ with ((<SDL.init>)). ((<SDL.init>)) initializes all the subsystems that
|
|
63
77
|
:SDL::INIT_AUDIO
|
64
78
|
Initialize autio subsystems.
|
65
79
|
:SDL::INIT_VIDEO
|
66
|
-
Initialize ((<
|
80
|
+
Initialize ((<Video>)) subsystem.
|
67
81
|
:SDL::INIT_CDROM
|
68
|
-
Initialize ((<
|
82
|
+
Initialize ((<CD-ROM>)) subsystem.
|
69
83
|
:SDL::INIT_JOYSTICK
|
70
|
-
Initialize ((<
|
84
|
+
Initialize ((<Joystick>)) subsystem.
|
71
85
|
:SDL::INIT_EVERYTHING
|
72
86
|
Initialize all of the avobe.
|
73
87
|
|
@@ -211,6 +225,8 @@ with ((<SDL.init>)). ((<SDL.init>)) initializes all the subsystems that
|
|
211
225
|
* ((<SDL::Surface.load_bmp>)) -- Load a Windows BMP file into an SDL_Surface.
|
212
226
|
* ((<SDL::Surface.load_bmp_from_io>)) -- Load a Windows BMP file into an Surface from IO object.
|
213
227
|
* ((<SDL::Surface#save_bmp>)) -- Save an SDL_Surface as a Windows BMP file.
|
228
|
+
* ((<SDL::Surface#destroy>)) -- Frees a Surface
|
229
|
+
* ((<SDL::Surface#destroyed?>)) -- Returns whether surface is destoryed or not.
|
214
230
|
* ((<SDL::Surface#set_color_key>)) -- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration.
|
215
231
|
* ((<SDL::Surface#set_alpha>)) -- Adjust the alpha properties of a surface
|
216
232
|
* ((<SDL::Surface#set_clip_rect>)) -- Sets the clipping rectangle for a surface.
|
@@ -313,6 +329,8 @@ can be drawn to.
|
|
313
329
|
* ((<SDL::Surface.load_bmp>)) -- Load a Windows BMP file into an SDL_Surface.
|
314
330
|
* ((<SDL::Surface.load_bmp_from_io>)) -- Load a Windows BMP file into an Surface from IO object.
|
315
331
|
* ((<SDL::Surface#save_bmp>)) -- Save an SDL_Surface as a Windows BMP file.
|
332
|
+
* ((<SDL::Surface#destroy>)) -- Frees a Surface
|
333
|
+
* ((<SDL::Surface#destroyed?>)) -- Returns whether surface is destoryed or not.
|
316
334
|
* ((<SDL::Surface#set_color_key>)) -- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration.
|
317
335
|
* ((<SDL::Surface#set_alpha>)) -- Adjust the alpha properties of a surface
|
318
336
|
* ((<SDL::Surface#set_clip_rect>)) -- Sets the clipping rectangle for a surface.
|
@@ -1253,6 +1271,24 @@ Not documented yet.
|
|
1253
1271
|
|
1254
1272
|
((<SDL::Surface.load_bmp>))
|
1255
1273
|
|
1274
|
+
--- SDL::Surface#destroy
|
1275
|
+
|
1276
|
+
Frees the resource used by a Surface.
|
1277
|
+
If a surface is destroyed, all operations are forbidden.
|
1278
|
+
|
1279
|
+
* See Also
|
1280
|
+
|
1281
|
+
((<SDL::Surface.new>)), ((<SDL::Surface.new_from>)), ((<SDL::Surface#destroyed?>))
|
1282
|
+
|
1283
|
+
--- SDL::Surface#destroyed?
|
1284
|
+
|
1285
|
+
Returns whether the surface is destroyed by
|
1286
|
+
((<SDL::Surface#destroy>)).
|
1287
|
+
|
1288
|
+
* See Also
|
1289
|
+
|
1290
|
+
((<SDL::Surface#destroy>))
|
1291
|
+
|
1256
1292
|
--- SDL::Surface#set_color_key(flag,key)
|
1257
1293
|
--- SDL::Surface#setColorKey(flag,key)
|
1258
1294
|
|
@@ -1822,15 +1858,15 @@ Not documented yet.
|
|
1822
1858
|
|
1823
1859
|
:0
|
1824
1860
|
Default
|
1825
|
-
:SDL::TRANSFORM_SAFE
|
1861
|
+
:SDL::Surface::TRANSFORM_SAFE
|
1826
1862
|
Don't asume that the ((|src|)) and ((|dst|)) surfaces has
|
1827
1863
|
the same pixel format. This is the default when the two
|
1828
1864
|
surfaces don't have the same BPP. This is slower but will
|
1829
1865
|
render wierd pixel formats right.
|
1830
|
-
:SDL::TRANSFORM_AA
|
1866
|
+
:SDL::Surface::TRANSFORM_AA
|
1831
1867
|
Use the interpolating renderer. Much slower but
|
1832
1868
|
can look better.
|
1833
|
-
:SDL::TRANSFORM_TMAP
|
1869
|
+
:SDL::Surface::TRANSFORM_TMAP
|
1834
1870
|
Use texture mapping. This is a bit faster but
|
1835
1871
|
the result isn't as nice as in the normal mode. This mode
|
1836
1872
|
will also ignore the px/py coordinates and the other flags.
|
@@ -1874,14 +1910,14 @@ Not documented yet.
|
|
1874
1910
|
--- SDL::Surface.transformBlit(src,dst,angle,xscale,yscale,px,py,qx,qy,flags)
|
1875
1911
|
|
1876
1912
|
Draw a rotated and scaled image.
|
1877
|
-
This method is same as ((<SDL::Surface.
|
1913
|
+
This method is same as ((<SDL::Surface.transform_draw>)) except
|
1878
1914
|
colorkey and blending are enabled.
|
1879
1915
|
|
1880
1916
|
|
1881
1917
|
You need SGE to use this method.
|
1882
1918
|
* See Also
|
1883
1919
|
|
1884
|
-
((<SDL::Surface.
|
1920
|
+
((<SDL::Surface.transform_draw>)), ((<SDL::Surface#transform_surface>)), ((<SDL::Surface#set_color_key>)), ((<SDL::Surface#set_alpha>))
|
1885
1921
|
|
1886
1922
|
--- SDL::Surface#draw_line(x1,x2,y1,y2,color, aa=false, alpha=nil)
|
1887
1923
|
--- SDL::Surface#drawLine(x1,x2,y1,y2,color, aa=false, alpha=nil)
|
@@ -2304,7 +2340,7 @@ Not documented yet.
|
|
2304
2340
|
--- SDL::Surface#transformSurface(bgcolor,angle,xscale,yscale,flags)
|
2305
2341
|
|
2306
2342
|
Returns a rotated and scaled version of ((|self|)).
|
2307
|
-
See ((|Surface.
|
2343
|
+
See ((|Surface.transform_draw|)) for more information.
|
2308
2344
|
((|bgcolor|)) is background color that new surface have.
|
2309
2345
|
|
2310
2346
|
The new surface object will have the same depth
|
@@ -2318,7 +2354,7 @@ Not documented yet.
|
|
2318
2354
|
You need SGE to use this method.
|
2319
2355
|
* See Also
|
2320
2356
|
|
2321
|
-
((<SDL::Surface.
|
2357
|
+
((<SDL::Surface.transform_draw>)), ((<SDL::Surface.transform_blit>))
|
2322
2358
|
|
2323
2359
|
= OpenGL
|
2324
2360
|
* ((<OpenGL outline>))
|
@@ -2336,7 +2372,7 @@ This allows you to use SDL's audio, event handling and times in your
|
|
2336
2372
|
OpenGL applications (a function often performed by GLUT).
|
2337
2373
|
|
2338
2374
|
Ruby/SDL has no OpenGL methods, please use
|
2339
|
-
((<
|
2375
|
+
((<ruby-opengl|URL:http://ruby-opengl.rubyforge.org/>)) or
|
2340
2376
|
((<riko|URL:http://www.kumaryu.net/?(Ruby)+Riko>))
|
2341
2377
|
with Ruby/SDL.
|
2342
2378
|
|
@@ -2487,6 +2523,13 @@ from windowed mode to fullscreen (if available)
|
|
2487
2523
|
|
2488
2524
|
Sets the title-bar and icon name of the display window.
|
2489
2525
|
|
2526
|
+
* NOTES
|
2527
|
+
|
2528
|
+
((|title|)) and ((|icon|)) must be UTF8 or ASCII string.
|
2529
|
+
|
2530
|
+
If Ruby/SDL m17n support is enabled,
|
2531
|
+
((|title|)) and ((|icon|)) are converted to UTF8 automatically.
|
2532
|
+
|
2490
2533
|
* See Also
|
2491
2534
|
|
2492
2535
|
((<SDL::WM.caption>)), ((<SDL::WM.icon=>))
|
@@ -2596,7 +2639,7 @@ from windowed mode to fullscreen (if available)
|
|
2596
2639
|
* ((<SDL::Event::JoyButtonDown#which>)) -- Joystick device index
|
2597
2640
|
* ((<SDL::Event::JoyButtonDown#button>)) -- Joystick button index
|
2598
2641
|
* ((<SDL::Event::JoyButtonDown#press>)) -- Joystick button is pressed or released
|
2599
|
-
* ((<SDL::Event::
|
2642
|
+
* ((<SDL::Event::JoyButtonUp#which>)) -- Joystick device index
|
2600
2643
|
* ((<SDL::Event::JoyButtonUp#button>)) -- Joystick button index
|
2601
2644
|
* ((<SDL::Event::JoyButtonUp#press>)) -- Joystick button is pressed or released
|
2602
2645
|
* ((<SDL::Event::VideoResize#w>)) -- New width of the window.
|
@@ -2821,7 +2864,7 @@ Class for joystick button release event.
|
|
2821
2864
|
|
2822
2865
|
This event occurs when a user releases a button on a joystick.
|
2823
2866
|
|
2824
|
-
* ((<SDL::Event::
|
2867
|
+
* ((<SDL::Event::JoyButtonUp#which>)) -- Joystick device index
|
2825
2868
|
* ((<SDL::Event::JoyButtonUp#button>)) -- Joystick button index
|
2826
2869
|
* ((<SDL::Event::JoyButtonUp#press>)) -- Joystick button is pressed or released
|
2827
2870
|
|
@@ -3065,8 +3108,12 @@ This module defines some mouse constants and module functions.
|
|
3065
3108
|
|
3066
3109
|
* NOTES
|
3067
3110
|
|
3068
|
-
|
3069
|
-
|
3111
|
+
In Ruby 1.9 and above, this method releases the global VM lock (GVL) prior to
|
3112
|
+
calling the underlying SDL_WaitEvent function. This allows other Ruby threads to
|
3113
|
+
continue executing while waiting for an event.
|
3114
|
+
|
3115
|
+
In Ruby 1.8 and below, there is no way to release the GVL, so all Ruby threads
|
3116
|
+
suspend execution until this method finishes.
|
3070
3117
|
|
3071
3118
|
* See Also
|
3072
3119
|
|
@@ -3431,7 +3478,7 @@ This module defines some mouse constants and module functions.
|
|
3431
3478
|
|
3432
3479
|
((<SDL::Event::JoyButtonUp#press>)), ((<SDL::Joystick#button>))
|
3433
3480
|
|
3434
|
-
--- SDL::Event::
|
3481
|
+
--- SDL::Event::JoyButtonUp#which
|
3435
3482
|
|
3436
3483
|
Returns the index of the joystick that reported the event.
|
3437
3484
|
|
@@ -3921,6 +3968,8 @@ The class represents one joystick.
|
|
3921
3968
|
* ((<SDL::CD#in_drive?>)) -- Check disc in drive
|
3922
3969
|
* ((<SDL::CD.frames_to_msf>)) -- Convert frames into minitus/seconds/frames
|
3923
3970
|
* ((<SDL::CD.msf_to_frames>)) -- Convert minitus/seconds/frames into frames
|
3971
|
+
* ((<SDL::CD#close>)) -- Closes a CD handle
|
3972
|
+
* ((<SDL::CD#closed?>)) -- Returns whether CD is closed
|
3924
3973
|
|
3925
3974
|
== CD-ROM outline
|
3926
3975
|
SDL supports audio control of up to 32 local CD-ROM drives at once.
|
@@ -4184,6 +4233,23 @@ layout of the tracks on the disc.
|
|
4184
4233
|
|
4185
4234
|
((<SDL::CD.frames_to_msf>))
|
4186
4235
|
|
4236
|
+
--- SDL::CD#close
|
4237
|
+
|
4238
|
+
Closes ((|self|)).
|
4239
|
+
|
4240
|
+
* See Also
|
4241
|
+
|
4242
|
+
((<SDL::CD.open>)), ((<SDL::CD#closed?>))
|
4243
|
+
|
4244
|
+
--- SDL::CD#closed?
|
4245
|
+
|
4246
|
+
Returns whether CD handle is closed by
|
4247
|
+
((<SDL::CD#close>))
|
4248
|
+
|
4249
|
+
* See Also
|
4250
|
+
|
4251
|
+
((<SDL::CD#close>))
|
4252
|
+
|
4187
4253
|
= Audio
|
4188
4254
|
* ((<Audio subsystem outline>))
|
4189
4255
|
* ((<Audio Format>))
|
@@ -4196,8 +4262,12 @@ layout of the tracks on the disc.
|
|
4196
4262
|
* ((<SDL::Mixer.driver_name>)) -- Gets the audio device name
|
4197
4263
|
* ((<SDL::Mixer::Wave.load>)) -- Load file for use as a sample.
|
4198
4264
|
* ((<SDL::Mixer::Wave.load_from_io>)) -- Read IO object for use as a sample.
|
4265
|
+
* ((<SDL::Mixer::Wave#destroy>)) -- Frees an audio chunk.
|
4266
|
+
* ((<SDL::Mixer::Wave#destroyed?>)) -- Returns whether an audio chunk is destroyed.
|
4199
4267
|
* ((<SDL::Mixer::Music.load>)) -- Load music file.
|
4200
4268
|
* ((<SDL::Mixer::Music.load_from_string>)) -- Convert string into music data.
|
4269
|
+
* ((<SDL::Mixer::Music#destroy>)) -- Frees an music data.
|
4270
|
+
* ((<SDL::Mixer::Music#destroyed?>)) -- Returns whether an music data is destroyed.
|
4201
4271
|
* ((<SDL::Mixer::Wave#set_volume>)) -- Set volume
|
4202
4272
|
* ((<SDL::Mixer.allocate_channels>)) -- Set the number of channels to mix
|
4203
4273
|
* ((<SDL::Mixer.set_volume>)) -- Set the mix volume of a channel
|
@@ -4393,6 +4463,24 @@ Suppor formats are WAVE, MOD, MIDI, OGG, MP3.
|
|
4393
4463
|
It must know the output characteristics so it can convert the sample for playback, it does
|
4394
4464
|
this conversion at load time. Therefore you should pay attention to memory consumption.
|
4395
4465
|
|
4466
|
+
--- SDL::Mixer::Wave#destroy
|
4467
|
+
|
4468
|
+
Frees an audio chunk previously loaded.
|
4469
|
+
If this method is called, all operations are forbidden.
|
4470
|
+
|
4471
|
+
* See Also
|
4472
|
+
|
4473
|
+
((<SDL::Mixer::Wave#destroyed?>))
|
4474
|
+
|
4475
|
+
--- SDL::Mixer::Wave#destroyed?
|
4476
|
+
|
4477
|
+
Returns whether au audio chunk is destroyed by
|
4478
|
+
((<SDL::Mixer::Wave#destroy>))
|
4479
|
+
|
4480
|
+
* See Also
|
4481
|
+
|
4482
|
+
((<SDL::Mixer::Wave#destroy>))
|
4483
|
+
|
4396
4484
|
--- SDL::Mixer::Music.load(filename)
|
4397
4485
|
|
4398
4486
|
Load music file to use and returns a instance of ((<SDL::Mixer::Music>)).
|
@@ -4419,6 +4507,24 @@ Suppor formats are WAVE, MOD, MIDI, OGG, MP3.
|
|
4419
4507
|
|
4420
4508
|
On Windows, it may be impossible to use this method.
|
4421
4509
|
|
4510
|
+
--- SDL::Mixer::Music#destroy
|
4511
|
+
|
4512
|
+
Frees an music data previously loaded.
|
4513
|
+
If this method is called, all operations are forbidden.
|
4514
|
+
|
4515
|
+
* See Also
|
4516
|
+
|
4517
|
+
((<SDL::Mixer::Music#destroyed?>)), ((<SDL::Mixer::Wave#destroy>))
|
4518
|
+
|
4519
|
+
--- SDL::Mixer::Music#destroyed?
|
4520
|
+
|
4521
|
+
Returns whether a music data is destroyed by
|
4522
|
+
((<SDL::Mixer::Music#destroy>))
|
4523
|
+
|
4524
|
+
* See Also
|
4525
|
+
|
4526
|
+
((<SDL::Mixer::Music#destroy>)), ((<SDL::Mixer::Wave#destroyed?>))
|
4527
|
+
|
4422
4528
|
--- SDL::Mixer::Wave#set_volume(volume)
|
4423
4529
|
--- SDL::Mixer::Wave#setVolume(volume)
|
4424
4530
|
|
@@ -4816,6 +4922,8 @@ and a way to wait a little while.
|
|
4816
4922
|
* ((<SDL::TTF.init>)) -- Initialize TTF APIs
|
4817
4923
|
* ((<SDL::TTF.init?>)) -- Query TTF API initialization status
|
4818
4924
|
* ((<SDL::TTF.open>)) -- Load font From a file
|
4925
|
+
* ((<SDL::TTF#close>)) -- Closes a font
|
4926
|
+
* ((<SDL::TTF#closed?>)) -- Returns whether a font is closed or not
|
4819
4927
|
* ((<SDL::TTF#style>)) -- Get font render style
|
4820
4928
|
* ((<SDL::TTF#style=>)) -- Set the rendering style.
|
4821
4929
|
* ((<SDL::TTF#height>)) -- Get font max height
|
@@ -4826,7 +4934,7 @@ and a way to wait a little while.
|
|
4826
4934
|
* ((<SDL::TTF#fixed_width?>)) -- Get whether font is monospaced or not.
|
4827
4935
|
* ((<SDL::TTF#family_name>)) -- Get current font face family name string
|
4828
4936
|
* ((<SDL::TTF#style_name>)) -- Get current font face style name string
|
4829
|
-
* ((<SDL::TTF#text_size>)) -- Get size of
|
4937
|
+
* ((<SDL::TTF#text_size>)) -- Get size of text string as would be rendered
|
4830
4938
|
* ((<SDL::TTF#render_solid_utf8>)) -- Render UTF8 text in solid mode
|
4831
4939
|
* ((<SDL::TTF#render_shaded_utf8>)) -- Render UTF8 text in shaded mode
|
4832
4940
|
* ((<SDL::TTF#render_blended_utf8>)) -- Render UTF8 text in blended mode
|
@@ -4834,14 +4942,19 @@ and a way to wait a little while.
|
|
4834
4942
|
* ((<SDL::TTF#draw_shaded_utf8>)) -- Draw UTF8 text in shaded mode
|
4835
4943
|
* ((<SDL::TTF#draw_blended_utf8>)) -- Draw UTF8 text in blended mode
|
4836
4944
|
* ((<SDL::BMFont.open>)) -- Load a bitmap font from file
|
4945
|
+
* ((<SDL::BMFont#close>)) -- Closes a font.
|
4946
|
+
* ((<SDL::BMFont#closed?>)) -- Returns whether a font is closed.
|
4837
4947
|
* ((<SDL::BMFont#set_color>)) -- Change font color
|
4838
4948
|
* ((<SDL::BMFont#height>)) -- Get height of the font
|
4839
4949
|
* ((<SDL::BMFont#width>)) -- Get width of one character in the font
|
4840
4950
|
* ((<SDL::BMFont#text_size>)) -- Get the size of surface needed
|
4841
4951
|
* ((<SDL::BMFont#textout>)) -- Render the given string
|
4842
4952
|
* ((<SDL::Kanji.open>)) -- Load bdf font file
|
4953
|
+
* ((<SDL::Kanji#close>)) -- Closes bdf font data
|
4954
|
+
* ((<SDL::Kanji#closed?>)) -- Returns whether bdf font is closed
|
4843
4955
|
* ((<SDL::Kanji#add>)) -- Add font data into already loaded font
|
4844
4956
|
* ((<SDL::Kanji#set_coding_system>)) -- Set character encoding
|
4957
|
+
* ((<SDL::Kanji#get_coding_system>)) -- Get character encoding
|
4845
4958
|
* ((<SDL::Kanji#height>)) -- Get height of one character
|
4846
4959
|
* ((<SDL::Kanji#textwidth>)) -- Get width of given string
|
4847
4960
|
* ((<SDL::Kanji#width>)) -- Get the width of one character
|
@@ -4885,6 +4998,8 @@ Each system has following features.
|
|
4885
4998
|
* ((<SDL::TTF.init>)) -- Initialize TTF APIs
|
4886
4999
|
* ((<SDL::TTF.init?>)) -- Query TTF API initialization status
|
4887
5000
|
* ((<SDL::TTF.open>)) -- Load font From a file
|
5001
|
+
* ((<SDL::TTF#close>)) -- Closes a font
|
5002
|
+
* ((<SDL::TTF#closed?>)) -- Returns whether a font is closed or not
|
4888
5003
|
* ((<SDL::TTF#style>)) -- Get font render style
|
4889
5004
|
* ((<SDL::TTF#style=>)) -- Set the rendering style.
|
4890
5005
|
* ((<SDL::TTF#height>)) -- Get font max height
|
@@ -4895,7 +5010,7 @@ Each system has following features.
|
|
4895
5010
|
* ((<SDL::TTF#fixed_width?>)) -- Get whether font is monospaced or not.
|
4896
5011
|
* ((<SDL::TTF#family_name>)) -- Get current font face family name string
|
4897
5012
|
* ((<SDL::TTF#style_name>)) -- Get current font face style name string
|
4898
|
-
* ((<SDL::TTF#text_size>)) -- Get size of
|
5013
|
+
* ((<SDL::TTF#text_size>)) -- Get size of text string as would be rendered
|
4899
5014
|
* ((<SDL::TTF#render_solid_utf8>)) -- Render UTF8 text in solid mode
|
4900
5015
|
* ((<SDL::TTF#render_shaded_utf8>)) -- Render UTF8 text in shaded mode
|
4901
5016
|
* ((<SDL::TTF#render_blended_utf8>)) -- Render UTF8 text in blended mode
|
@@ -4912,6 +5027,8 @@ Note that you should pay attention to font license.
|
|
4912
5027
|
|
4913
5028
|
== SDL::BMFont
|
4914
5029
|
* ((<SDL::BMFont.open>)) -- Load a bitmap font from file
|
5030
|
+
* ((<SDL::BMFont#close>)) -- Closes a font.
|
5031
|
+
* ((<SDL::BMFont#closed?>)) -- Returns whether a font is closed.
|
4915
5032
|
* ((<SDL::BMFont#set_color>)) -- Change font color
|
4916
5033
|
* ((<SDL::BMFont#height>)) -- Get height of the font
|
4917
5034
|
* ((<SDL::BMFont#width>)) -- Get width of one character in the font
|
@@ -4924,8 +5041,11 @@ is needed.
|
|
4924
5041
|
|
4925
5042
|
== SDL::Kanji
|
4926
5043
|
* ((<SDL::Kanji.open>)) -- Load bdf font file
|
5044
|
+
* ((<SDL::Kanji#close>)) -- Closes bdf font data
|
5045
|
+
* ((<SDL::Kanji#closed?>)) -- Returns whether bdf font is closed
|
4927
5046
|
* ((<SDL::Kanji#add>)) -- Add font data into already loaded font
|
4928
5047
|
* ((<SDL::Kanji#set_coding_system>)) -- Set character encoding
|
5048
|
+
* ((<SDL::Kanji#get_coding_system>)) -- Get character encoding
|
4929
5049
|
* ((<SDL::Kanji#height>)) -- Get height of one character
|
4930
5050
|
* ((<SDL::Kanji#textwidth>)) -- Get width of given string
|
4931
5051
|
* ((<SDL::Kanji#width>)) -- Get the width of one character
|
@@ -4972,6 +5092,26 @@ This class represets bdf font.
|
|
4972
5092
|
SDL::TTF.init
|
4973
5093
|
font = SDL::TTF.open("font.ttf", 32, 0)
|
4974
5094
|
|
5095
|
+
--- SDL::TTF#close
|
5096
|
+
|
5097
|
+
Closes a font and free related resources.
|
5098
|
+
|
5099
|
+
|
5100
|
+
You need SDL_ttf to use this method.
|
5101
|
+
* See Also
|
5102
|
+
|
5103
|
+
((<SDL::TTF#closed?>))
|
5104
|
+
|
5105
|
+
--- SDL::TTF#closed?
|
5106
|
+
|
5107
|
+
Returns whether a font is closed by ((<SDL::TTF#close>))
|
5108
|
+
|
5109
|
+
|
5110
|
+
You need SDL_ttf to use this method.
|
5111
|
+
* See Also
|
5112
|
+
|
5113
|
+
((<SDL::TTF#close>))
|
5114
|
+
|
4975
5115
|
--- SDL::TTF#style
|
4976
5116
|
|
4977
5117
|
Returns the rendering style as a bitmask composed of the follwing masks:
|
@@ -5139,6 +5279,11 @@ This class represets bdf font.
|
|
5139
5279
|
w, h = font.size_text("Hello World!")
|
5140
5280
|
puts "width=#{w} height=#{h}"
|
5141
5281
|
|
5282
|
+
* NOTES
|
5283
|
+
|
5284
|
+
If Ruby/SDL m17n support is enabled,
|
5285
|
+
((|text|)) will be converted to suitable encoding.
|
5286
|
+
|
5142
5287
|
* See Also
|
5143
5288
|
|
5144
5289
|
((<SDL::TTF#render_solid_utf8>)), ((<SDL::TTF#render_shaded_utf8>)), ((<SDL::TTF#render_blended_utf8>)), ((<SDL::TTF#draw_solid_utf8>)), ((<SDL::TTF#draw_shaded_utf8>)), ((<SDL::TTF#draw_blended_utf8>))
|
@@ -5288,6 +5433,26 @@ This class represets bdf font.
|
|
5288
5433
|
|
5289
5434
|
|
5290
5435
|
You need SGE to use this method.
|
5436
|
+
--- SDL::BMFont#close
|
5437
|
+
|
5438
|
+
Closes a font and release the resources.
|
5439
|
+
|
5440
|
+
|
5441
|
+
You need SGE to use this method.
|
5442
|
+
* See Also
|
5443
|
+
|
5444
|
+
((<SDL::BMFont.open>)), ((<SDL::BMFont#closed?>))
|
5445
|
+
|
5446
|
+
--- SDL::BMFont#closed?
|
5447
|
+
|
5448
|
+
Returns whether a font is closed by ((<SDL::BMFont#close>)).
|
5449
|
+
|
5450
|
+
|
5451
|
+
You need SGE to use this method.
|
5452
|
+
* See Also
|
5453
|
+
|
5454
|
+
((<SDL::BMFont#close>))
|
5455
|
+
|
5291
5456
|
--- SDL::BMFont#set_color(r, g, b)
|
5292
5457
|
--- SDL::BMFont#setColor(r, g, b)
|
5293
5458
|
|
@@ -5352,6 +5517,23 @@ This class represets bdf font.
|
|
5352
5517
|
|
5353
5518
|
((<SDL::Kanji#add>))
|
5354
5519
|
|
5520
|
+
--- SDL::Kanji#close
|
5521
|
+
|
5522
|
+
Closes bdf font data and release
|
5523
|
+
the resouces and memories.
|
5524
|
+
|
5525
|
+
* See Also
|
5526
|
+
|
5527
|
+
((<SDL::Kanji.open>)), ((<SDL::Kanji#closed?>))
|
5528
|
+
|
5529
|
+
--- SDL::Kanji#closed?
|
5530
|
+
|
5531
|
+
Returns whether bdf font is closed by ((<SDL::Kanji#close>))
|
5532
|
+
|
5533
|
+
* See Also
|
5534
|
+
|
5535
|
+
((<SDL::Kanji#close>))
|
5536
|
+
|
5355
5537
|
--- SDL::Kanji#add(filename)
|
5356
5538
|
|
5357
5539
|
Add font data fromt ((|filename|)) into already loaded font ((|self|)).
|
@@ -5359,7 +5541,7 @@ This class represets bdf font.
|
|
5359
5541
|
|
5360
5542
|
* See Also
|
5361
5543
|
|
5362
|
-
((<SDL::Kanji
|
5544
|
+
((<SDL::Kanji.open>))
|
5363
5545
|
|
5364
5546
|
--- SDL::Kanji#set_coding_system(sys)
|
5365
5547
|
--- SDL::Kanji#setCodingSystem(sys)
|
@@ -5370,6 +5552,23 @@ This class represets bdf font.
|
|
5370
5552
|
* SDL::Kanji::JIS
|
5371
5553
|
Default is SDL::Kanji::JIS.
|
5372
5554
|
|
5555
|
+
* See Also
|
5556
|
+
|
5557
|
+
((<SDL::Kanji#get_coding_system>))
|
5558
|
+
|
5559
|
+
--- SDL::Kanji#get_coding_system
|
5560
|
+
--- SDL::Kanji#getCodingSystem
|
5561
|
+
|
5562
|
+
Get encoding. A return value is one of following:
|
5563
|
+
* SDL::Kanji::SJIS
|
5564
|
+
* SDL::Kanji::EUC
|
5565
|
+
* SDL::Kanji::JIS
|
5566
|
+
Default is SDL::Kanji::JIS.
|
5567
|
+
|
5568
|
+
* See Also
|
5569
|
+
|
5570
|
+
((<SDL::Kanji#set_coding_system>))
|
5571
|
+
|
5373
5572
|
--- SDL::Kanji#height
|
5374
5573
|
|
5375
5574
|
Returns the height of one character as piexel.
|
@@ -5388,16 +5587,21 @@ This class represets bdf font.
|
|
5388
5587
|
|
5389
5588
|
* See Also
|
5390
5589
|
|
5391
|
-
((<SDL
|
5590
|
+
((<SDL::Kanji#textwidth>))
|
5392
5591
|
|
5393
5592
|
--- SDL::Kanji#put(surface, text, x, y, r, g, b)
|
5394
5593
|
|
5395
5594
|
Renders ((|text|)) at (((|x|)), ((|y|))) in ((|surface|))
|
5396
5595
|
with (((|r|)), ((|g|)), ((|b|))) color.
|
5397
5596
|
|
5597
|
+
* NOTES
|
5598
|
+
|
5599
|
+
If Ruby/SDL m17n support is enabled, ((|text|))
|
5600
|
+
will be converted to suitable encoding.
|
5601
|
+
|
5398
5602
|
* See Also
|
5399
5603
|
|
5400
|
-
((<SDL::Kanji#put_tate>))
|
5604
|
+
((<SDL::Kanji#put_tate>)), ((<SDL::Kanji#set_coding_system>))
|
5401
5605
|
|
5402
5606
|
--- SDL::Kanji#put_tate(surface, x, y, r, g, b)
|
5403
5607
|
--- SDL::Kanji#putTate(surface, x, y, r, g, b)
|
@@ -5407,9 +5611,14 @@ This class represets bdf font.
|
|
5407
5611
|
|
5408
5612
|
`Half-width' character is not rendered.
|
5409
5613
|
|
5614
|
+
* NOTES
|
5615
|
+
|
5616
|
+
If Ruby/SDL m17n support is enabled, ((|text|))
|
5617
|
+
will be converted to suitable encoding.
|
5618
|
+
|
5410
5619
|
* See Also
|
5411
5620
|
|
5412
|
-
((<SDL::Kanji#put>))
|
5621
|
+
((<SDL::Kanji#put>)), ((<SDL::Kanji#set_coding_system>))
|
5413
5622
|
|
5414
5623
|
= Collision Detection
|
5415
5624
|
* ((<Collision Detection outline>))
|
@@ -5418,6 +5627,7 @@ This class represets bdf font.
|
|
5418
5627
|
* ((<Collision Detection Methods>))
|
5419
5628
|
* ((<SDL::Surface#make_collision_map>)) -- Creates a new collision map
|
5420
5629
|
* ((<SDL::CollisionMap#collision_check>)) -- Does pixel collision detection.
|
5630
|
+
* ((<SDL::CollisionMap.bounding_box_check>)) -- Checks if two shapes overlap.
|
5421
5631
|
* ((<SDL::CollisionMap#bounding_box_check>)) -- Checks if two shapes overlap.
|
5422
5632
|
* ((<SDL::CollisionMap#clear>)) -- Clears an area in the collision map
|
5423
5633
|
* ((<SDL::CollisionMap#set>)) -- Makes an area in the collision map solid
|
@@ -5440,6 +5650,7 @@ You can create this instance only by
|
|
5440
5650
|
((<SDL::Surface#make_collision_map>)).
|
5441
5651
|
|
5442
5652
|
* ((<SDL::CollisionMap#collision_check>)) -- Does pixel collision detection.
|
5653
|
+
* ((<SDL::CollisionMap.bounding_box_check>)) -- Checks if two shapes overlap.
|
5443
5654
|
* ((<SDL::CollisionMap#bounding_box_check>)) -- Checks if two shapes overlap.
|
5444
5655
|
* ((<SDL::CollisionMap#clear>)) -- Clears an area in the collision map
|
5445
5656
|
* ((<SDL::CollisionMap#set>)) -- Makes an area in the collision map solid
|
@@ -5478,6 +5689,23 @@ You can create this instance only by
|
|
5478
5689
|
internally.
|
5479
5690
|
|
5480
5691
|
|
5692
|
+
You need SGE to use this method.
|
5693
|
+
* See Also
|
5694
|
+
|
5695
|
+
((<SDL::CollisionMap#bounding_box_check>))
|
5696
|
+
|
5697
|
+
--- SDL::CollisionMap.bounding_box_check(x1,y1,w1,h1,x2,y2,w2,h2)
|
5698
|
+
--- SDL::CollisionMap.boundingBoxCheck(x1,y1,w1,h1,x2,y2,w2,h2)
|
5699
|
+
|
5700
|
+
|
5701
|
+
Checks if two rectangles
|
5702
|
+
(((|x1|)), ((|$y1|)), ((|w1|)), ((|h1|))) and
|
5703
|
+
(((|x2|)), ((|$y2|)), ((|w2|)), ((|h2|))) overlap.
|
5704
|
+
|
5705
|
+
Returns true if two rectangles overlap, otherwise
|
5706
|
+
returns false.
|
5707
|
+
|
5708
|
+
|
5481
5709
|
You need SGE to use this method.
|
5482
5710
|
* See Also
|
5483
5711
|
|
@@ -5500,7 +5728,7 @@ You can create this instance only by
|
|
5500
5728
|
You need SGE to use this method.
|
5501
5729
|
* See Also
|
5502
5730
|
|
5503
|
-
((<SDL::CollisionMap#collision_check>)), ((<SDL::CollisionMap#w>)), ((<SDL::CollisionMap#h>))
|
5731
|
+
((<SDL::CollisionMap.bounding_box_check>)), ((<SDL::CollisionMap#collision_check>)), ((<SDL::CollisionMap#w>)), ((<SDL::CollisionMap#h>))
|
5504
5732
|
|
5505
5733
|
--- SDL::CollisionMap#clear(x, y, w, h)
|
5506
5734
|
|
@@ -5863,9 +6091,14 @@ Load text data from a file and create new table object.
|
|
5863
6091
|
|
5864
6092
|
|
5865
6093
|
You need SDLSKK to use this method.
|
6094
|
+
* NOTES
|
6095
|
+
|
6096
|
+
If Ruby/SDL m17n support is enabled,
|
6097
|
+
the string with proper encoding will be returned.
|
6098
|
+
|
5866
6099
|
* See Also
|
5867
6100
|
|
5868
|
-
((<SDL::SKK::Context#render_str>)), ((<SDL::SKK::Context#clear>)), ((<SDL::SKK::Context#clear_text>))
|
6101
|
+
((<SDL::SKK::Context#render_str>)), ((<SDL::SKK::Context#clear>)), ((<SDL::SKK::Context#clear_text>)), ((<SDL::SKK.encoding>))
|
5869
6102
|
|
5870
6103
|
--- SDL::SKK::Context#render_str(font, r, g, b)
|
5871
6104
|
|
@@ -5960,6 +6193,8 @@ Load text data from a file and create new table object.
|
|
5960
6193
|
* ((<SDL::MPEG::Info#total_size>)) --
|
5961
6194
|
* ((<SDL::MPEG::Info#current_time>)) --
|
5962
6195
|
* ((<SDL::MPEG#total_time>)) --
|
6196
|
+
* ((<SDL::MPEG#delete>)) --
|
6197
|
+
* ((<SDL::MPEG#deleted?>)) --
|
5963
6198
|
|
5964
6199
|
== MPEG playback Outline
|
5965
6200
|
Ruby/SDL enables you to play MPEG movie
|
@@ -6000,6 +6235,8 @@ This class represents MPEG stream and playing state.
|
|
6000
6235
|
* ((<SDL::MPEG#render_final>)) -- Render the last frame of an MPEG video
|
6001
6236
|
* ((<SDL::MPEG#set_filer>)) -- Set video filter
|
6002
6237
|
* ((<SDL::MPEG#total_time>)) --
|
6238
|
+
* ((<SDL::MPEG#delete>)) --
|
6239
|
+
* ((<SDL::MPEG#deleted?>)) --
|
6003
6240
|
|
6004
6241
|
== SDL::MPEG::Info
|
6005
6242
|
This class represents ((<SDL::MPEG>)) information.
|
@@ -6335,4 +6572,16 @@ You can get instance by ((<SDL::MPEG#info>)).
|
|
6335
6572
|
not documented yet
|
6336
6573
|
|
6337
6574
|
|
6575
|
+
You need SMPEG to use this method.
|
6576
|
+
--- SDL::MPEG#delete
|
6577
|
+
|
6578
|
+
not documented yet
|
6579
|
+
|
6580
|
+
|
6581
|
+
You need SMPEG to use this method.
|
6582
|
+
--- SDL::MPEG#deleted?
|
6583
|
+
|
6584
|
+
not documented yet
|
6585
|
+
|
6586
|
+
|
6338
6587
|
You need SMPEG to use this method.
|