Module Application

module Application: sig .. end

Provides a unified interface to the one-instance aspects of SDL, such as setting the video mode and waiting for events. An example of how to get this up and running:


	let renderer = new default_renderer in
	renderer#set_scene_root (new some_scene_node_to_display ) ;
	display_singleton#set_renderer (renderer :> renderer) ;
	display_singleton#set_video_mode ~width:640 ~height:480 ;
	display_singleton#event_loop

If you want to get started with one line of code, try


	open FatCaml.Application

	simply_display (new some_scene_node_to_display)

exception Done

class virtual renderer : object .. end

Renders stuff.

val null_renderer : renderer

Renders nothing, quietly.

class virtual display_singleton_type : object .. end

Provides a unified interface to the single-instance aspects of SDL, such as setting the video mode and waiting for events.

val display_singleton : display_singleton_type

The implementation of display_singleton_type.

class camera_perspective_renderer : object .. end

Renders the scene from the perspective of a camera.

class default_renderer : camera_perspective_renderer

Most simple applications will use camera_perspective_renderer, calling it default_renderer is much more lucid.

class ortho_pixel_renderer : unit -> object .. end

Renders a scene with world cordinates mapped one-to-one with pixels.

class overlay_renderer : renderer list -> object .. end

Renders several renderer's on top of each other.

class column_renderer : object .. end

class camera_marker : ?camera:Scene.camera -> unit -> object .. end

Renders the bounding edges a camera's view-volume.

val simply_display : ?distance:float -> ?textures:bool -> Scene.scene_node -> unit

Initializes FatCaml and displays the specified node. The camera is positioned at 10 on the Z axis, facing towards the origin.

Example:


	open FatCaml.Texture
	open FatCaml.Primitives
	
	let main () =
		let texture = load_gl_texture "foo.png" in
		let cube = make_cube ~texture 3.0 in
		simply_display ~textures:true cube
	
	let _ = main ()

distance : position on the Z axis. Defaults to 10.0.

textures : enable texture rendering. Defaults to false.