Wiki Page Content

Differences between revisions 11 and 32 (spanning 21 versions)
Revision 11 as of 2009-12-10 07:49:32
Size: 1758
Editor: SheenaSmith
Comment: content added
Revision 32 as of 2014-02-09 22:23:58
Size: 1533
Editor: mattbentley
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
#pragma disable-camelcase #pragma camelcase off
Line 5: Line 5:
A structure that contains information on the capabilities of a render driver or context. A structure that contains information on the capabilities of a render driver or the current render context.
Line 12: Line 12:
||Uint32||'''mod_modes'''||a mask of supported channel modulation; see [[#mod_modes|Remarks]] for details||
||Uint32||'''blend_modes'''||a mask of supported blend modes||
||Uint32||'''scale_modes'''||a mask of supported scale modes||
Line 16: Line 13:
||Uint32[20]||'''texture_formats'''||the available texture formats||
||int||'''max_texture_width'''||the maximimum texture width||
||int||'''max_texture_height'''||the maximimum texture height||

## Use the following markup to display values on a related function page: <<Include(SDL_RendererInfo, , , from="== Data Fields ==", to="== Code Examples ==")>>
||Uint32[16]||'''texture_formats'''||the available texture formats; see [[#texture_formats|Remarks]] for details||
||int||'''max_texture_width'''||the maximum texture width||
||int||'''max_texture_height'''||the maximum texture height||
Line 28: Line 23:
<<Anchor(flags)>> '''flags''' may be a mask of any of the following [[SDL_RendererFlags]] values OR'd together: <<Include(SDL_RendererFlags, , , from="== Values ==", to="== Code Examples ==")>> <<Anchor(flags)>> '''flags''' may be 0 or a mask of any of the following [[SDL_RendererFlags]] values OR'd together: <<Include(SDL_RendererFlags, , , from="== Values ==", to="== Code Examples ==")>>
Line 30: Line 25:
<<Anchor(mod_modes)>> '''mod_modes''' may be a mask of any of the following [[SDL_TextureModulate]] values OR'd together: <<Include(SDL_TextureModulate, , , from="== Values ==", to="== Code Examples ==")>>
<<Anchor(texture_formats)>> '''texture_formats''' is an array of [[SDL_PixelFormatEnum]] values representing the available texture formats for the renderer <<Include(SDL_PixelFormatEnum, , , from="== Values ==", to="== Code Examples ==")>>
Line 34: Line 28:
 .[[SDL_BlendMode]]
Line 39: Line 34:
 .[[SDL_FunctionLeaveSectionIfEmpty]]  .[[SDL_GetRenderDriverInfo]]
 .[[SDL_GetRendererInfo]]
 .[[SDL_RenderCopy]]
Line 42: Line 39:
[[CategoryStruct]] [[CategoryStruct]], [[CategoryRender]]

SDL_RendererInfo

A structure that contains information on the capabilities of a render driver or the current render context.

Data Fields

const char*

name

the name of the renderer

Uint32

flags

a mask of supported renderer flags; see Remarks for details

Uint32

num_texture_formats

the number of available texture formats

Uint32[16]

texture_formats

the available texture formats; see Remarks for details

int

max_texture_width

the maximum texture width

int

max_texture_height

the maximum texture height

Code Examples

You can add your code example here

Remarks

flags may be 0 or a mask of any of the following SDL_RendererFlags values OR'd together:

SDL_RENDERER_SOFTWARE

the renderer is a software fallback

SDL_RENDERER_ACCELERATED

the renderer uses hardware acceleration

SDL_RENDERER_PRESENTVSYNC

present is synchronized with the refresh rate

SDL_RENDERER_TARGETTEXTURE

the renderer supports rendering to texture

Note that providing no flags gives priority to available SDL_RENDERER_ACCELERATED renderers.

texture_formats is an array of SDL_PixelFormatEnum values representing the available texture formats for the renderer

Pixel Format Macros

SDL_PIXELTYPE(format)

the type of the pixel format; see Remarks for details

SDL_PIXELORDER(format)

the ordering of channels or bits in the pixel format; see Remarks for details

SDL_PIXELLAYOUT(format)

the channel bit pattern of the pixel format; see Remarks for details

SDL_BITSPERPIXEL(format)

the number of bits of color information in the pixel format

SDL_BYTESPERPIXEL(format)

the number of bytes used to represent a pixel

SDL_ISPIXELFORMAT_INDEXED(format)

true for pixel formats that have a palette

SDL_ISPIXELFORMAT_ALPHA(format)

true for pixel formats that have an alpha channel

SDL_ISPIXELFORMAT_FOURCC(format)

true for pixel formats representing unique formats, for example YUV formats

Pixel Format Values

SDL_PIXELFORMAT_UNKNOWN

SDL_PIXELFORMAT_INDEX1LSB

SDL_PIXELFORMAT_INDEX1MSB

SDL_PIXELFORMAT_INDEX4LSB

SDL_PIXELFORMAT_INDEX4MSB

SDL_PIXELFORMAT_INDEX8

SDL_PIXELFORMAT_RGB332

SDL_PIXELFORMAT_RGB444

SDL_PIXELFORMAT_RGB555

SDL_PIXELFORMAT_BGR555

SDL_PIXELFORMAT_ARGB4444

SDL_PIXELFORMAT_RGBA4444

SDL_PIXELFORMAT_ABGR4444

SDL_PIXELFORMAT_BGRA4444

SDL_PIXELFORMAT_ARGB1555

SDL_PIXELFORMAT_RGBA5551

SDL_PIXELFORMAT_ABGR1555

SDL_PIXELFORMAT_BGRA5551

SDL_PIXELFORMAT_RGB565

SDL_PIXELFORMAT_BGR565

SDL_PIXELFORMAT_RGB24

SDL_PIXELFORMAT_BGR24

SDL_PIXELFORMAT_RGB888

SDL_PIXELFORMAT_RGBX8888

SDL_PIXELFORMAT_BGR888

SDL_PIXELFORMAT_BGRX8888

SDL_PIXELFORMAT_ARGB8888

SDL_PIXELFORMAT_RGBA8888

SDL_PIXELFORMAT_ABGR8888

SDL_PIXELFORMAT_BGRA8888

SDL_PIXELFORMAT_ARGB2101010

SDL_PIXELFORMAT_RGBA32

alias for RGBA byte array of color data, for the current platform (>= SDL 2.0.5)

SDL_PIXELFORMAT_ARGB32

alias for ARGB byte array of color data, for the current platform (>= SDL 2.0.5)

SDL_PIXELFORMAT_BGRA32

alias for BGRA byte array of color data, for the current platform (>= SDL 2.0.5)

SDL_PIXELFORMAT_ABGR32

alias for ABGR byte array of color data, for the current platform (>= SDL 2.0.5)

SDL_PIXELFORMAT_YV12

planar mode: Y + V + U (3 planes)

SDL_PIXELFORMAT_IYUV

planar mode: Y + U + V (3 planes)

SDL_PIXELFORMAT_YUY2

packed mode: Y0+U0+Y1+V0 (1 plane)

SDL_PIXELFORMAT_UYVY

packed mode: U0+Y0+V0+Y1 (1 plane)

SDL_PIXELFORMAT_YVYU

packed mode: Y0+V0+Y1+U0 (1 plane)

SDL_PIXELFORMAT_NV12

planar mode: Y + U/V interleaved (2 planes) (>= SDL 2.0.4)

SDL_PIXELFORMAT_NV21

planar mode: Y + V/U interleaved (2 planes) (>= SDL 2.0.4)


CategoryStruct, CategoryRender

None: SDL_RendererInfo (last edited 2014-02-09 22:23:58 by mattbentley)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit