Difference between revisions of "love.graphics.newQuad"

(explain precise purpose of the parameters)
(Unfortunately, the various dimensions must not be necessary, so a Quad can't encapsulate a flipping.)
Line 8: Line 8:
 
{{param|number|x|The top-left position along the x-axis.}}
 
{{param|number|x|The top-left position along the x-axis.}}
 
{{param|number|y|The top-left position along the y-axis.}}
 
{{param|number|y|The top-left position along the y-axis.}}
{{param|number|width|The width of the Quad.}}
+
{{param|number|width|The width of the Quad. Must be greater than 0.}}
{{param|number|height|The height of the Quad.}}
+
{{param|number|height|The height of the Quad. Must be greater than 0.}}
{{param|number|sw|The reference width.}}
+
{{param|number|sw|The reference width. Must be greater than 0.}}
{{param|number|sh|The reference height.}}
+
{{param|number|sh|The reference height. Must be greater than 0.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|Quad|quad|The new Quad.}}
 
{{param|Quad|quad|The new Quad.}}
 
=== Note ===
 
=== Note ===
The purpose of a quad is to describe the result of the following transformation on any drawable object. The object is first scaled to dimensions sw × sh. The quad then describes the rectangular area of dimensions width × height whose upper left corner inside the scaled object is at position (x, y).
+
The purpose of a Quad is to describe the result of the following transformation on any drawable object. The object is first scaled to dimensions sw × sh. The Quad then describes the rectangular area of dimensions width × height whose upper left corner is at position (x, y) inside the scaled object.
  
 
== Examples ==
 
== Examples ==

Revision as of 02:26, 15 January 2012

Creates a new Quad.

Function

Synopsis

quad = love.graphics.newQuad( x, y, width, height, sw, sh )

Arguments

number x
The top-left position along the x-axis.
number y
The top-left position along the y-axis.
number width
The width of the Quad. Must be greater than 0.
number height
The height of the Quad. Must be greater than 0.
number sw
The reference width. Must be greater than 0.
number sh
The reference height. Must be greater than 0.

Returns

Quad quad
The new Quad.

Note

The purpose of a Quad is to describe the result of the following transformation on any drawable object. The object is first scaled to dimensions sw × sh. The Quad then describes the rectangular area of dimensions width × height whose upper left corner is at position (x, y) inside the scaled object.

Examples

Use a Quad to display part of an Image:

img = love.graphics.newImage("mushroom-64x64.png")

-- Let's say we want to display only the top-left 
-- 32x32 quadrant of the Image:
top_left = love.graphics.newQuad(0, 0, 32, 32, 64, 64)

-- And here is bottom left:
bottom_left = love.graphics.newQuad(0, 32, 32, 32, 64, 64)

function love.draw()
	love.graphics.drawq(img, top_left, 50, 50)
	love.graphics.drawq(img, bottom_left, 50, 200)
end

See Also


Other Languages