A bitmap surface

Introduced properties

fun format: SDL_PixelFormat

sdl2 :: SDLSurface :: format

Format of the pixels
fun h: Int

sdl2 :: SDLSurface :: h

Height in pixels
init load(path: CString): SDLSurface

sdl2 :: SDLSurface :: load

Load the image at path inferring its type from the file extension
init load_bmp(path: CString): SDLSurface

sdl2 :: SDLSurface :: load_bmp

Load the BMP file at path
fun pitch: Int

sdl2 :: SDLSurface :: pitch

Bytes in a row of pixels
fun pixels: Pointer

sdl2 :: SDLSurface :: pixels

Pointer to pixel data
fun save_bmp(path: CString)

sdl2 :: SDLSurface :: save_bmp

Save this texture to a BMP file
fun w: Int

sdl2 :: SDLSurface :: w

Width in pixels

Redefined properties

redef type SELF: SDLSurface

sdl2 $ SDLSurface :: SELF

Type of this instance, automatically specialized in every class
redef fun free

sdl2 $ SDLSurface :: free

Free the memory pointed by this pointer

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun address_is_null: Bool

core :: Pointer :: address_is_null

Is the address behind this Object at NULL?
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun format: SDL_PixelFormat

sdl2 :: SDLSurface :: format

Format of the pixels
fun free

core :: Pointer :: free

Free the memory pointed by this pointer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun h: Int

sdl2 :: SDLSurface :: h

Height in pixels
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
init load(path: CString): SDLSurface

sdl2 :: SDLSurface :: load

Load the image at path inferring its type from the file extension
init load_bmp(path: CString): SDLSurface

sdl2 :: SDLSurface :: load_bmp

Load the BMP file at path
init nul: Pointer

core :: Pointer :: nul

C NULL pointer
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun pitch: Int

sdl2 :: SDLSurface :: pitch

Bytes in a row of pixels
fun pixels: Pointer

sdl2 :: SDLSurface :: pixels

Pointer to pixel data
fun save_bmp(path: CString)

sdl2 :: SDLSurface :: save_bmp

Save this texture to a BMP file
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun w: Int

sdl2 :: SDLSurface :: w

Width in pixels
package_diagram sdl2::SDLSurface SDLSurface core::Pointer Pointer sdl2::SDLSurface->core::Pointer core::Object Object core::Pointer->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

extern class Pointer

core :: Pointer

Pointer classes are used to manipulate extern C structures.

Class definitions

sdl2 $ SDLSurface
# A bitmap surface
extern class SDLSurface `{ SDL_Surface * `}

	# Load the BMP file at `path`
	new load_bmp(path: CString) `{ return SDL_LoadBMP(path); `}

	redef fun free `{ SDL_FreeSurface(self); `}

	# Save this texture to a BMP file
	fun save_bmp(path: CString) `{ SDL_SaveBMP(self, path); `}

	# Format of the pixels
	fun format: SDL_PixelFormat `{ return self->format; `}

	# Width in pixels
	fun w: Int `{ return self->w; `}

	# Height in pixels
	fun h: Int `{ return self->h; `}

	# Bytes in a row of pixels
	fun pitch: Int `{ return self->pitch; `}

	# Pointer to pixel data
	fun pixels: Pointer `{ return self->pixels; `}
end
lib/sdl2/sdl2_base.nit:397,1--422,3

sdl2 :: image $ SDLSurface
redef extern class SDLSurface
	# Load the image at `path` inferring its type from the file extension
	new load(path: CString) `{ return IMG_Load(path); `}
end
lib/sdl2/image.nit:57,1--60,3