Difference between revisions of "RenderTarget.new"
m (→Description) |
|||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | '''Available since:''' Gideros 2024.3<br/> | ||
| + | '''Class:''' [[RenderTarget]]<br/> | ||
| + | |||
| + | === Description === | ||
| + | Creates a new RenderTarget object (Gideros 2024.3+). | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | RenderTarget.new(width,height,filtering,options) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | === Parameters === | ||
| + | '''width''': (''number'') width of rendered texture<br/> | ||
| + | '''height''': (''number'') height of rendered texture<br/> | ||
| + | '''filtering''': (''boolean'') set texture filtering, that is smoothing the image ('''default = false''')<br/> | ||
| + | '''options''': now you can pass various options as a table: | ||
| + | * '''wrap''': (''string'') either ''"clamp"'' or ''"repeat"'' ('''default = "clamp"''')<br/> | ||
| + | * '''format''': (''string'') the wanted pixel format for this render target. Use one of the [[TextureBase]] format constants, or leave nil for default ('''default = [[TextureBase.RGBA8888]]''')<br/> | ||
| + | * '''extend''': (''boolean'') extend the texture to a power of two size internally ('''default = true''')<br/> | ||
| + | * '''mipmap''': (''boolean'') set texture mipmaping ('''default = false''')<br/> | ||
| + | |||
| + | === Example === | ||
| + | '''Gideros 2024.3+''' | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | local rt = RenderTarget.new(bmp:getWidth(), bmp:getHeight(), false, { extend=false }) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | === Reference === | ||
| + | https://github.com/gideros/gideros/blob/master/luabinding/rendertargetbinder.cpp | ||
| + | |||
| + | |||
| + | ---- | ||
| + | |||
| + | |||
'''Available since:''' Gideros 2013.06<br/> | '''Available since:''' Gideros 2013.06<br/> | ||
'''Class:''' [[RenderTarget]]<br/> | '''Class:''' [[RenderTarget]]<br/> | ||
| Line 5: | Line 37: | ||
=== Description === | === Description === | ||
Creates a new RenderTarget object. | Creates a new RenderTarget object. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
| − | RenderTarget.new(width,height,filtering,repeating,autoscale,depth) | + | RenderTarget.new(width,height,filtering,repeating,autoscale,depth,format,extend) |
| − | </ | + | </syntaxhighlight> |
=== Parameters === | === Parameters === | ||
'''width''': (number) width of rendered texture<br/> | '''width''': (number) width of rendered texture<br/> | ||
'''height''': (number) height of rendered texture<br/> | '''height''': (number) height of rendered texture<br/> | ||
| − | '''filtering''': (boolean) | + | '''filtering''': (boolean) set texture filtering, that is smoothing the image ('''default = false''')<br/> |
| − | '''repeating''': (boolean) | + | '''repeating''': (boolean) set texture repeating ('''default = false''')<br/> |
'''autoscale''': (boolean) whether the actual texture size should be scaled to match display resolution ('''default = false''')<br/> | '''autoscale''': (boolean) whether the actual texture size should be scaled to match display resolution ('''default = false''')<br/> | ||
| − | '''depth''': (boolean) | + | '''depth''': (boolean) indicate this rendertarget will hold depth component. Setting this to true creates a render target suitable for shadow mapping ('''default = false''')<br/> |
| + | '''format''': (string) specify the wanted pixel format for this render target. Use ones of the [[TextureBase]] format constants, or leave nil for default ('''default = [[TextureBase.RGBA8888]]''')<br/> | ||
| + | '''extend''': (boolean) extend the texture to a power of two size internally '''since Gideros 2022.5.1''' ('''default = true''')<br/> | ||
{{RenderTarget}} | {{RenderTarget}} | ||
Latest revision as of 20:49, 1 February 2025
Available since: Gideros 2024.3
Class: RenderTarget
Description
Creates a new RenderTarget object (Gideros 2024.3+).
RenderTarget.new(width,height,filtering,options)
Parameters
width: (number) width of rendered texture
height: (number) height of rendered texture
filtering: (boolean) set texture filtering, that is smoothing the image (default = false)
options: now you can pass various options as a table:
- wrap: (string) either "clamp" or "repeat" (default = "clamp")
- format: (string) the wanted pixel format for this render target. Use one of the TextureBase format constants, or leave nil for default (default = TextureBase.RGBA8888)
- extend: (boolean) extend the texture to a power of two size internally (default = true)
- mipmap: (boolean) set texture mipmaping (default = false)
Example
Gideros 2024.3+
local rt = RenderTarget.new(bmp:getWidth(), bmp:getHeight(), false, { extend=false })
Reference
https://github.com/gideros/gideros/blob/master/luabinding/rendertargetbinder.cpp
Available since: Gideros 2013.06
Class: RenderTarget
Description
Creates a new RenderTarget object.
RenderTarget.new(width,height,filtering,repeating,autoscale,depth,format,extend)
Parameters
width: (number) width of rendered texture
height: (number) height of rendered texture
filtering: (boolean) set texture filtering, that is smoothing the image (default = false)
repeating: (boolean) set texture repeating (default = false)
autoscale: (boolean) whether the actual texture size should be scaled to match display resolution (default = false)
depth: (boolean) indicate this rendertarget will hold depth component. Setting this to true creates a render target suitable for shadow mapping (default = false)
format: (string) specify the wanted pixel format for this render target. Use ones of the TextureBase format constants, or leave nil for default (default = TextureBase.RGBA8888)
extend: (boolean) extend the texture to a power of two size internally since Gideros 2022.5.1 (default = true)
