platform.gc - Revision history

Adriweb at 11:10, 6 June 2012

2012-06-06T11:10:34Z

Adriweb at 23:07, 24 May 2011

2011-05-24T23:07:14Z

Adriweb at 23:06, 24 May 2011

2011-05-24T23:06:50Z

Adriweb at 23:06, 24 May 2011

2011-05-24T23:06:23Z

Adriweb at 23:06, 24 May 2011

2011-05-24T23:06:10Z

Adriweb at 23:03, 24 May 2011

2011-05-24T23:03:54Z

Adriweb: Created page with "Returns a dummy graphics context.
It is typically used to measure pixel lengths and heights of strings when a normal graphics context is not available.
2011-05-24T23:02:27Z

Created page with "Returns a dummy graphics context.<br /> It is typically used to measure pixel lengths and heights of strings when a normal graphics context is not available.<br..."

New page
Returns a dummy [[:Category:gc|graphics context]].<br />

It is typically used to measure pixel lengths and heights of strings when a normal graphics context is not available.<br />
This may be the case when creating new text elements when the script app is initialized.<br />
A graphics context is available only during paint events, and that may be too late to create and size the containers for text fields.
This graphics context cannot be used to draw graphics since it is not tied to a window. It can however do that if this gc is used in a function called within [[on.paint]].
Here is an example of using the dummy graphics context to get the pixel length and height of a string.
<syntaxhighlight>local gc = platform.gc() -- Get the dummy graphics context
gc:begin() -- Makes it the current graphics context
local width = gc:getStringWidth(a_string) -- Gets the pixel length of a_string
local height = gc:getStringHeight(a_string) -- Gets the pixel height of a_string

-- do things here --
gc:finish() -- Restores previous graphics context</syntaxhighlight>
It is important to use [[gc:begin]]() to set up the graphics context before using it in the getString routines and to call [[gc:finish]]() to relinquish it when finished with it.
{{Since|3.0}}

[[Category:gc]]

← Older revision		Revision as of 11:10, 6 June 2012
Line 20:		Line 20:

	{{Since\|3.0}}		{{Since\|3.0}}
		+	{{ObsoleteSince\|3.2}}

	[[Category:platform]]		[[Category:platform]]

← Older revision		Revision as of 23:06, 24 May 2011
Line 1:		Line 1:
	Returns a dummy [[:Category:gc\|graphics context]].<br />		Returns a dummy [[:Category:gc\|graphics context]].<br />
		+
		+	As a consequence, you are able to use the functions made for the "normal" [[:Category:gc\|gc]]

	It is typically used to measure pixel lengths and heights of strings when a normal graphics context is not available.<br />		It is typically used to measure pixel lengths and heights of strings when a normal graphics context is not available.<br />

@@ Line 1: / Line 1: @@
 Returns a dummy [[:Category:gc|graphics context]].<br />
-As a consequence, you are able to use the functions made for the "normal" [[:Category:gc|gc]]
+As a consequence, you are able to use the functions made for the "normal" [[:Category:gc|gc]].
 It is typically used to measure pixel lengths and heights of strings when a normal graphics context is not available.<br />
@@ Line 9: / Line 9: @@
 <br />
-Here is an example of using the dummy graphics context to get the pixel length and height of a string.
+Here is an example of using the dummy graphics context to get the pixel length and height of a string :
 <syntaxhighlight>local gc = platform.gc()                     -- Get the dummy graphics context
 gc:begin()                                   -- Makes it the current graphics context

@@ Line 5: / Line 5: @@
 It is typically used to measure pixel lengths and heights of strings when a normal graphics context is not available.<br />
 This may be the case when creating new text elements when the script app is initialized.<br />
-A graphics context is available only during paint events, and that may be too late to create and size the containers for text fields.
+A graphics context is available only during paint events, and that may be too late to create and size the containers for text fields.<br />
 This graphics context cannot be used to draw graphics since it is not tied to a window. It can however do that if this gc is used in a function called within [[on.paint]].
 <br />

@@ Line 6: / Line 6: @@
 This graphics context cannot be used to draw graphics since it is not tied to a window. It can however do that if this gc is used in a function called within [[on.paint]].
 Here is an example of using the dummy graphics context to get the pixel length and height of a string.
-<syntaxhighlight>local gc = platform.gc()                  -- Get the dummy graphics context
+<syntaxhighlight>local gc = platform.gc()                     -- Get the dummy graphics context
-gc:begin()                                -- Makes it the current graphics context
+gc:begin()                                   -- Makes it the current graphics context
-local width = gc:getStringWidth(a_string) -- Gets the pixel length of a_string
+local width = gc:getStringWidth(a_string)    -- Gets the pixel length of a_string
-local height = gc:getStringHeight(a_string)      -- Gets the pixel height of a_string
+local height = gc:getStringHeight(a_string)  -- Gets the pixel height of a_string
 -- do things here --
-gc:finish()                               -- Restores previous graphics context</syntaxhighlight>
+gc:finish()                                  -- Restores previous graphics context</syntaxhighlight>
 It is important to use [[gc:begin]]() to set up the graphics context before using it in the getString routines and to call [[gc:finish]]() to relinquish it when finished with it.
 {{Since|3.0}}
-[[Category:gc]]
+[[Category:platform]]