Class: SDL2::Joystick

Inherits:
Object
  • Object
show all
Defined in:
joystick.c,
joystick.c

Overview

This class represents a joystick connected to the machine.

In order to use joystick subsystem, init must have been called with the SDL2::INIT_JOYSTICK flag.

Defined Under Namespace

Modules: Hat Classes: DeviceInfo

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.devices ⇒ Array<SDL2::Joystick::DeviceInfo>

Get the information of connected joysticks

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'joystick.c', line 68

static VALUE Joystick_s_devices(VALUE self)
{
    int num_joysticks = SDL_NumJoysticks();
    int i;
    VALUE devices = rb_ary_new2(num_joysticks);
    for (i=0; i<num_joysticks; ++i) {
        VALUE device = rb_obj_alloc(cDeviceInfo);
        rb_iv_set(device, "@GUID", GUID_to_String(SDL_JoystickGetDeviceGUID(i)));
        rb_iv_set(device, "@name", utf8str_new_cstr(SDL_JoystickNameForIndex(i)));
        rb_ary_push(devices, device);
    }
    return devices;
}

.game_controller?(index) ⇒ Boolean

Return true if the joystick of given index supports the game controller interface.

Parameters:

  • index (Integer) —

    the joystick device index

Returns:

  • (Boolean)

See Also:



109
110
111
112
 
# File 'joystick.c', line 109

static VALUE Joystick_s_game_controller_p(VALUE self, VALUE index)
{
    return INT2BOOL(SDL_IsGameController(NUM2INT(index)));
}

.num_connected_joysticks ⇒ Integer

Get the number of connected joysticks.

Returns:

  • (Integer) 


51
52
53
54
 
# File 'joystick.c', line 51

static VALUE Joystick_s_num_connected_joysticks(VALUE self)
{
    return INT2FIX(HANDLE_ERROR(SDL_NumJoysticks()));
}

.open(device_index) ⇒ SDL2::Joystick

Open a joystick for use.

Parameters:

  • device_index (Integer) —

    device index

Returns:

Raises:

  • (SDL2::Error) —

    raised when device open is failed. for exmaple, device_index is out of range.



91
92
93
94
95
96
97
 
# File 'joystick.c', line 91

static VALUE Joystick_s_open(VALUE self, VALUE device_index)
{
    SDL_Joystick* joystick = SDL_JoystickOpen(NUM2INT(device_index));
    if (!joystick)
        SDL_ERROR();
    return Joystick_new(joystick);
}

Instance Method Details

#attached? ⇒ Boolean

Return true a joystick has been opened and currently connected.

Returns:

  • (Boolean) 


117
118
119
120
121
122
123
 
# File 'joystick.c', line 117

static VALUE Joystick_attached_p(VALUE self)
{
    Joystick* j = Get_Joystick(self);
    if (!j->joystick)
        return Qfalse;
    return INT2BOOL(SDL_JoystickGetAttached(j->joystick));
}

#axis(which) ⇒ Integer

Get the current state of an axis control on a joystick.

Parameters:

  • which (Integer) —

    an index of an axis, started at index 0

Returns:

  • (Integer) —

    state value, ranging from -32768 to 32767.

See Also:



222
223
224
225
 
# File 'joystick.c', line 222

static VALUE Joystick_axis(VALUE self, VALUE which)
{
    return INT2FIX(SDL_JoystickGetAxis(Get_SDL_Joystick(self), NUM2INT(which)));
}

#ball(which) ⇒ Array(Integer,Integer)

Get the current state of a trackball on a joystick.

Parameters:

  • which (Integer) —

    an index of a trackball, started at index 0

Returns:

  • (Array(Integer,Integer)) —

    dx and dy

See Also:



235
236
237
238
239
240
 
# File 'joystick.c', line 235

static VALUE Joystick_ball(VALUE self, VALUE which)
{
    int dx, dy;
    HANDLE_ERROR(SDL_JoystickGetBall(Get_SDL_Joystick(self), NUM2INT(which), &dx, &dy));
    return rb_ary_new3(2, INT2NUM(dx), INT2NUM(dy));
}

#button(which) ⇒ Boolean

Get the current state of a button on a joystick.

Parameters:

  • which (Integer) —

    an index of a button, started at index 0

Returns:

  • (Boolean) —

    true if the button is pressed

See Also:



250
251
252
253
 
# File 'joystick.c', line 250

static VALUE Joystick_button(VALUE self, VALUE which)
{
    return INT2BOOL(SDL_JoystickGetButton(Get_SDL_Joystick(self), NUM2INT(which)));
}

#destroy ⇒ nil Also known as: close

Close a joystick device.

Returns:

  • (nil)

See Also:



155
156
157
158
159
160
161
162
 
# File 'joystick.c', line 155

static VALUE Joystick_destroy(VALUE self)
{
    Joystick* j = Get_Joystick(self);
    if (j->joystick)
        SDL_JoystickClose(j->joystick);
    j->joystick = NULL;
    return Qnil;
}

#destroy? ⇒ Boolean Also known as: close?

Return true if the device is alread closed.

Returns:

  • (Boolean)

See Also:

#GUID ⇒ String

Get the joystick GUID

Returns:

  • (String) —

    GUID string



130
131
132
133
134
135
136
137
 
# File 'joystick.c', line 130

static VALUE Joystick_GUID(VALUE self)
{
    SDL_JoystickGUID guid;
    char buf[128];
    guid = SDL_JoystickGetGUID(Get_SDL_Joystick(self));
    SDL_JoystickGetGUIDString(guid, buf, sizeof(buf));
    return rb_usascii_str_new_cstr(buf);
}

#hat(which) ⇒ Integer

Get the current state of a POV hat on a joystick.

Parameters:

  • which (Integer) —

    an index of a hat, started at index 0

Returns:

  • (Integer) —

    hat state

See Also:



263
264
265
266
 
# File 'joystick.c', line 263

static VALUE Joystick_hat(VALUE self, VALUE which)
{
    return UINT2NUM(SDL_JoystickGetHat(Get_SDL_Joystick(self), NUM2INT(which)));
}

#index ⇒ Integer

Get the index of a joystick

Returns:

  • (Integer) —

    index



144
145
146
147
 
# File 'joystick.c', line 144

static VALUE Joystick_index(VALUE self)
{
    return INT2NUM(HANDLE_ERROR(SDL_JoystickInstanceID(Get_SDL_Joystick(self))));
}

#name ⇒ String

Get the name of a joystick

Returns:

  • (String) —

    name



169
170
171
172
 
# File 'joystick.c', line 169

static VALUE Joystick_name(VALUE self)
{
    return utf8str_new_cstr(SDL_JoystickName(Get_SDL_Joystick(self)));
}

#num_axes ⇒ Integer

Get the number of general axis controls on a joystick.

Returns:

  • (Integer)

See Also:



179
180
181
182
 
# File 'joystick.c', line 179

static VALUE Joystick_num_axes(VALUE self)
{
    return INT2FIX(SDL_JoystickNumAxes(Get_SDL_Joystick(self)));
}

#num_balls ⇒ Integer

Get the number of trackball on a joystick

Returns:

  • (Integer)

See Also:



189
190
191
192
 
# File 'joystick.c', line 189

static VALUE Joystick_num_balls(VALUE self)
{
    return INT2FIX(SDL_JoystickNumBalls(Get_SDL_Joystick(self)));
}

#num_buttons ⇒ Integer

Get the number of button on a joystick

Returns:

  • (Integer)

See Also:



199
200
201
202
 
# File 'joystick.c', line 199

static VALUE Joystick_num_buttons(VALUE self)
{
    return INT2FIX(SDL_JoystickNumButtons(Get_SDL_Joystick(self)));
}

#num_hats ⇒ Integer

Get the number of POV hats on a joystick

Returns:

  • (Integer)

See Also:



209
210
211
212
 
# File 'joystick.c', line 209

static VALUE Joystick_num_hats(VALUE self)
{
    return INT2FIX(SDL_JoystickNumHats(Get_SDL_Joystick(self)));
}