1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
# coding: utf-8
# Copyright 2019 DragonRuby LLC
# MIT License
# outputs_docs.rb has been released under MIT (*only this file*).
module OutputsDocs
def docs_method_sort_order
[
:docs_class,
:docs_solids,
:docs_borders
]
end
def docs_class
<<-S
* DOCS: ~GTK::Outputs~
Outputs is how you render primitives to the screen. The minimal setup for
rendering something to the screen is via a ~tick~ method defined in
mygame/app/main.rb
#+begin_src
def tick args
# code goes here
end
#+end_src
S
end
def docs_borders
<<-S
* DOCS: ~GTK::Outputs#borders~
Add primitives to this collection to render an unfilled solid to the screen. Take a look at the
documentation for Outputs#solids.
The only difference between the two primitives is where they are added.
Instead of using ~args.outputs.solids~:
#+begin_src
def tick args
# X Y WIDTH HEIGHT
args.outputs.solids << [100, 100, 160, 90]
end
#+end_src
You have to use ~args.outputs.borders~:
#+begin_src
def tick args
# X Y WIDTH HEIGHT
args.outputs.borders << [100, 100, 160, 90]
end
#+end_src
S
end
def docs_solids
<<-S
* DOCS: ~GTK::Outputs#solids~
Add primitives to this collection to render a solid to the screen.
** Rendering a solid using an Array
Creates a solid black rectangle located at 100, 100. 160 pixels
wide and 90 pixels tall.
#+begin_src
def tick args
# X Y WIDTH HEIGHT
args.outputs.solids << [100, 100, 160, 90]
end
#+end_src
** Rendering a solid using an Array with colors and alpha
The value for the color and alpha is an number between ~0~ and ~255~. The
alpha property is optional and will be set to ~255~ if not specified.
Creates a green solid rectangle with an opacity of 50%.
#+begin_src
def tick args
# X Y WIDTH HEIGHT RED GREEN BLUE ALPHA
args.outputs.solids << [100, 100, 160, 90, 0, 255, 0, 128]
end
#+end_src
** Rendering a solid using a Hash
If you want a more readable invocation. You can use the following hash to create a solid.
Any parameters that are not specified will be given a default value. The keys of the hash can
be provided in any order.
#+begin_src
def tick args
args.outputs.solids << {
x: 0,
y: 0,
w: 100,
h: 100,
r: 0,
g: 255,
b: 0,
a: 255
}
end
#+end_src
** Rendering a solid using a Class
You can also create a class with solid/border properties and render it as a primitive.
ALL properties must on the class. *Additionally*, a method called ~primitive_marker~
must be defined on the class.
Here is an example:
#+begin_src
# Create type with ALL solid properties AND primitive_marker
class Solid
attr_accessor :x, :y, :w, :h, :r, :g, :b, :a
def primitive_marker
:solid
end
end
# Inherit from type
class Square < Solid
# constructor
def initialize x, y, size
self.x = x
self.y = y
self.w = size
self.h = size
end
end
def tick args
# render solid/border
args.outputs.solids << Square.new(10, 10, 32)
end
#+end_src
S
end
def docs_screenshots
<<-S
* DOCS: ~GTK::Outputs#screenshots~
Add a hash to this collection to take a screenshot and save as png file.
The keys of the hash can be provided in any order.
#+begin_src
def tick args
args.outputs.screenshots << {
x: 0, y: 0, w: 100, h: 100, # Which portion of the screen should be captured
path: 'screenshot.png', # Output path of PNG file (inside game directory)
r: 255, g: 255, b: 255, a: 0 # Optional chroma key
}
end
#+end_src
** Chroma key (Making a color transparent)
By specifying the r, g, b and a keys of the hash you change the transparency of a color in the resulting PNG file.
This can be useful if you want to create files with transparent background like spritesheets.
The transparency of the color specified by ~r~, ~g~, ~b~ will be set to the transparency specified by ~a~.
The example above sets the color white (255, 255, 255) as transparent.
S
end
end
class GTK::Outputs
extend Docs
extend OutputsDocs
end
|
