2D rendering context More...

#include <SDL2pp/Renderer.hh>

Public Member Functions
	Renderer (SDL_Renderer *renderer)
	Construct from existing SDL_Renderer structure.

	Renderer (Window &window, int index, Uint32 flags)
	Create renderer.

virtual	~Renderer ()
	Destructor.

	Renderer (Renderer &&other) noexcept
	Move constructor.

Renderer &	operator= (Renderer &&other) noexcept
	Move assignment operator.

	Renderer (const Renderer &other)=delete
	Deleted copy constructor.

Renderer &	operator= (const Renderer &other)=delete
	Deleted assignment operator.

SDL_Renderer *	Get () const
	Get pointer to managed SDL_Renderer structure.

Renderer &	Present ()
	Update the screen with any rendering performed since the previous call.

Renderer &	Clear ()
	Clear the current rendering target with the drawing color.

void	GetInfo (SDL_RendererInfo &info)
	Get information about a rendering context.

Renderer &	Copy (Texture &texture, const Optional< Rect > &srcrect=NullOpt, const Optional< Rect > &dstrect=NullOpt)
	Copy a portion of the texture to the current rendering target.

Renderer &	Copy (Texture &texture, const Optional< Rect > &srcrect, const Point &dstpoint)
	Copy a portion of the texture to the current rendering target (preserve texture dimensions)

Renderer &	Copy (Texture &texture, const Optional< Rect > &srcrect, const Optional< Rect > &dstrect, double angle, const Optional< Point > &center=NullOpt, int flip=0)
	Copy a portion of the texture to the current rendering target with optional rotating or flipping.

Renderer &	Copy (Texture &texture, const Optional< Rect > &srcrect, const SDL2pp::Point &dstpoint, double angle, const Optional< Point > &center=NullOpt, int flip=0)
	Copy a portion of the texture to the current rendering target with optional rotating or flipping (preserve texture dimensions)

Renderer &	FillCopy (Texture &texture, const Optional< Rect > &srcrect=NullOpt, const Optional< Rect > &dstrect=NullOpt, const Point &offset=Point(0, 0), int flip=0)
	Fill the target with repeated source texture.

Renderer &	SetDrawColor (Uint8 r=0, Uint8 g=0, Uint8 b=0, Uint8 a=255)
	Set color user for drawing operations.

Renderer &	SetDrawColor (const Color &color)
	Set color user for drawing operations.

Renderer &	SetTarget ()
	Set current render target to default.

Renderer &	SetTarget (Texture &texture)
	Set current render target to specified texture.

Renderer &	SetDrawBlendMode (SDL_BlendMode blendMode=SDL_BLENDMODE_NONE)
	Set the blend mode used for drawing operations.

Renderer &	DrawPoint (int x, int y)
	Draw a point on the current rendering target.

Renderer &	DrawPoint (const Point &p)
	Draw a point on the current rendering target.

Renderer &	DrawPoints (const Point *points, int count)
	Draw multiple points on the current rendering target.

Renderer &	DrawLine (int x1, int y1, int x2, int y2)
	Draw a line on the current rendering target.

Renderer &	DrawLine (const Point &p1, const Point &p2)
	Draw a line on the current rendering target.

Renderer &	DrawLines (const Point *points, int count)
	Draw a polyline on the current rendering target.

Renderer &	DrawRect (int x1, int y1, int x2, int y2)
	Draw a rectangle on the current rendering target.

Renderer &	DrawRect (const Point &p1, const Point &p2)
	Draw a rectangle on the current rendering target.

Renderer &	DrawRect (const Rect &r)
	Draw a rectangle on the current rendering target.

Renderer &	DrawRects (const Rect *rects, int count)
	Draw multiple rectangles on the current rendering target.

Renderer &	FillRect (int x1, int y1, int x2, int y2)
	Fill a rectangle on the current rendering target.

Renderer &	FillRect (const Point &p1, const Point &p2)
	Fill a rectangle on the current rendering target.

Renderer &	FillRect (const Rect &r)
	Fill a rectangle on the current rendering target.

Renderer &	FillRects (const Rect *rects, int count)
	Fill multiple rectangles on the current rendering target.

void	ReadPixels (const Optional< Rect > &rect, Uint32 format, void *pixels, int pitch)
	Read pixels from the current rendering target.

Renderer &	SetClipRect (const Optional< Rect > &rect=NullOpt)
	Set the clipping rectangle for rendering.

Renderer &	SetLogicalSize (int w, int h)
	Set a device independent resolution for rendering.

Renderer &	SetScale (float scaleX, float scaleY)
	Set the drawing scale for rendering on the current target.

Renderer &	SetViewport (const Optional< Rect > &rect=NullOpt)
	Set the drawing area for rendering on the current target.

bool	TargetSupported () const
	Determine whether a window supports the use of render targets.

Optional< Rect >	GetClipRect () const
	Get the clip rectangle for the current target.

Point	GetLogicalSize () const
	Get device independent resolution for rendering.

int	GetLogicalWidth () const
	Get device independent width resolution for rendering.

int	GetLogicalHeight () const
	Get device independent width resolution for rendering.

void	GetScale (float &scalex, float &scaley) const
	Get the drawing scale for the current target.

float	GetXScale () const
	Get the drawing scale for the current target.

float	GetYScale () const
	Get the drawing scale for the current target.

Rect	GetViewport () const
	Get the drawing area for the current target.

SDL_BlendMode	GetDrawBlendMode () const
	Get the blend mode used for drawing operations.

Color	GetDrawColor () const
	Get the additional color value multiplied into render copy operations.

void	GetDrawColor (Uint8 &r, Uint8 &g, Uint8 &b, Uint8 &a) const
	Get the additional color value multiplied into render copy operations.

Point	GetOutputSize () const
	Get the output size of a rendering context.

int	GetOutputWidth () const
	Get the output width of a rendering context.

int	GetOutputHeight () const
	Get the output height of a rendering context.

Detailed Description

2D rendering context

Constructor & Destructor Documentation

◆ Renderer() [1/4]

SDL2pp::Renderer::Renderer ( SDL_Renderer * renderer )

explicit

Construct from existing SDL_Renderer structure.

Parameters

[in] renderer Existing SDL_Renderer to manage

◆ Renderer() [2/4]

SDL2pp::Renderer::Renderer	(	Window &	window,
		int	index,
		Uint32	flags
	)

Create renderer.

Parameters

[in]	window	Window where rendering is displayed
[in]	index	Index of the rendering driver to initialize, or -1 to initialize the first one supporting the requested flags
[in]	flags	0 or more SDL_RendererFlags OR'ed together

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_CreateRenderer

◆ ~Renderer()

SDL2pp::Renderer::~Renderer ( )

virtual

Destructor.

See also: http://wiki.libsdl.org/SDL_DestroyRenderer

◆ Renderer() [3/4]

SDL2pp::Renderer::Renderer ( Renderer && other )

noexcept

Move constructor.

Parameters

[in] other SDL2pp::Renderer object to move data from

◆ Renderer() [4/4]

SDL2pp::Renderer::Renderer ( const Renderer & other )

delete

Deleted copy constructor.

This class is not copyable

Member Function Documentation

◆ Clear()

Renderer & SDL2pp::Renderer::Clear ( )

Clear the current rendering target with the drawing color.

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderClear

◆ Copy() [1/4]

Renderer & SDL2pp::Renderer::Copy	(	Texture &	texture,
		const Optional< Rect > &	srcrect,
		const Optional< Rect > &	dstrect,
		double	angle,
		const Optional< Point > &	center = `NullOpt`,
		int	flip = `0`
	)

Copy a portion of the texture to the current rendering target with optional rotating or flipping.

Parameters

[in]	texture	Source texture
[in]	srcrect	Source rectangle, NullOpt for the entire texture
[in]	dstrect	Destination rectangle, NullOpt for the entire rendering target
[in]	angle	Angle in degrees that indicates the rotation that will be applied to dstrect
[in]	center	Point indicating the point around which dstrect will be rotated (NullOpt to rotate around dstrect center)
[in]	flip	SDL_RendererFlip value stating which flipping actions should be performed on the texture

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RendererFlip; http://wiki.libsdl.org/SDL_RenderCopyEx

◆ Copy() [2/4]

Renderer & SDL2pp::Renderer::Copy	(	Texture &	texture,
		const Optional< Rect > &	srcrect,
		const Point &	dstpoint
	)

Copy a portion of the texture to the current rendering target (preserve texture dimensions)

Parameters

[in]	texture	Source texture
[in]	srcrect	Source rectangle, NullOpt for the entire texture
[in]	dstpoint	Target point for source top left corner

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderCopy

◆ Copy() [3/4]

Renderer & SDL2pp::Renderer::Copy	(	Texture &	texture,
		const Optional< Rect > &	srcrect,
		const SDL2pp::Point &	dstpoint,
		double	angle,
		const Optional< Point > &	center = `NullOpt`,
		int	flip = `0`
	)

Copy a portion of the texture to the current rendering target with optional rotating or flipping (preserve texture dimensions)

Parameters

[in]	texture	Source texture
[in]	srcrect	Source rectangle, NullOpt for the entire texture
[in]	dstpoint	Target point for source top left corner
[in]	angle	Angle in degrees that indicates the rotation that will be applied to dstrect
[in]	center	Point indicating the point around which dstrect will be rotated (NullOpt to rotate around dstrect center)
[in]	flip	SDL_RendererFlip value stating which flipping actions should be performed on the texture

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RendererFlip; http://wiki.libsdl.org/SDL_RenderCopyEx

◆ Copy() [4/4]

Renderer & SDL2pp::Renderer::Copy	(	Texture &	texture,
		const Optional< Rect > &	srcrect = `NullOpt`,
		const Optional< Rect > &	dstrect = `NullOpt`
	)

Copy a portion of the texture to the current rendering target.

Parameters

[in]	texture	Source texture
[in]	srcrect	Source rectangle, NullOpt for the entire texture
[in]	dstrect	Destination rectangle, NullOpt for the entire rendering target

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderCopy

◆ DrawLine() [1/2]

Renderer & SDL2pp::Renderer::DrawLine	(	const Point &	p1,
		const Point &	p2
	)

Draw a line on the current rendering target.

Parameters

[in]	p1	Coordinates of the start point
[in]	p2	Coordinates of the end point

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawLine

◆ DrawLine() [2/2]

Renderer & SDL2pp::Renderer::DrawLine	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Draw a line on the current rendering target.

Parameters

[in]	x1	X coordinate of the start point
[in]	y1	Y coordinate of the start point
[in]	x2	X coordinate of the end point
[in]	y2	Y coordinate of the end point

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawLine

◆ DrawLines()

Renderer & SDL2pp::Renderer::DrawLines	(	const Point *	points,
		int	count
	)

Draw a polyline on the current rendering target.

Parameters

[in]	points	Array of coordinates of points along the polyline
[in]	count	Number of points to draw count-1 polyline segments

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawLines

◆ DrawPoint() [1/2]

Renderer & SDL2pp::Renderer::DrawPoint ( const Point & p )

Draw a point on the current rendering target.

Parameters

[in] p Coordinates of the point

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawPoint

◆ DrawPoint() [2/2]

Renderer & SDL2pp::Renderer::DrawPoint	(	int	x,
		int	y
	)

Draw a point on the current rendering target.

Parameters

[in]	x	X coordinate of the point
[in]	y	Y coordinate of the point

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawPoint

◆ DrawPoints()

Renderer & SDL2pp::Renderer::DrawPoints	(	const Point *	points,
		int	count
	)

Draw multiple points on the current rendering target.

Parameters

[in]	points	Array of coordinates of points to draw
[in]	count	Number of points to draw

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawPoints

◆ DrawRect() [1/3]

Renderer & SDL2pp::Renderer::DrawRect	(	const Point &	p1,
		const Point &	p2
	)

Draw a rectangle on the current rendering target.

Parameters

[in]	p1	Coordinates of the start corner
[in]	p2	Coordinates of the end corner

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawRect

◆ DrawRect() [2/3]

Renderer & SDL2pp::Renderer::DrawRect ( const Rect & r )

Draw a rectangle on the current rendering target.

Parameters

[in] r Rectangle to draw

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawRect

◆ DrawRect() [3/3]

Renderer & SDL2pp::Renderer::DrawRect	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Draw a rectangle on the current rendering target.

Parameters

[in]	x1	X coordinate of the start corner
[in]	y1	Y coordinate of the start corner
[in]	x2	X coordinate of the end corner
[in]	y2	Y coordinate of the end corner

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawRect

◆ DrawRects()

Renderer & SDL2pp::Renderer::DrawRects	(	const Rect *	rects,
		int	count
	)

Draw multiple rectangles on the current rendering target.

Parameters

[in]	rects	Array of rectangles to draw
[in]	count	Number of rectangles

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderDrawRects

◆ FillCopy()

Renderer & SDL2pp::Renderer::FillCopy	(	Texture &	texture,
		const Optional< Rect > &	srcrect = `NullOpt`,
		const Optional< Rect > &	dstrect = `NullOpt`,
		const Point &	offset = `Point(0, 0)`,
		int	flip = `0`
	)

Fill the target with repeated source texture.

Parameters

[in]	texture	Source texture
[in]	srcrect	Source rectangle, NullOpt for the entire texture
[in]	dstrect	Destination rectangle, NullOpt for the entire rendering target
[in]	offset	Offset of tiled texture in pixels relative to dstrect
[in]	flip	SDL_RendererFlip value stating which flipping actions should be performed on the texture

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RendererFlip; http://wiki.libsdl.org/SDL_RenderCopy; http://wiki.libsdl.org/SDL_RenderCopyEx

◆ FillRect() [1/3]

Renderer & SDL2pp::Renderer::FillRect	(	const Point &	p1,
		const Point &	p2
	)

Fill a rectangle on the current rendering target.

Parameters

[in]	p1	Coordinates of the start corner
[in]	p2	Coordinates of the end corner

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderFillRect

◆ FillRect() [2/3]

Renderer & SDL2pp::Renderer::FillRect ( const Rect & r )

Fill a rectangle on the current rendering target.

Parameters

[in] r Rectangle to draw

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderFillRect

◆ FillRect() [3/3]

Renderer & SDL2pp::Renderer::FillRect	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Fill a rectangle on the current rendering target.

Parameters

[in]	x1	X coordinate of the start corner
[in]	y1	Y coordinate of the start corner
[in]	x2	X coordinate of the end corner
[in]	y2	Y coordinate of the end corner

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderFillRect

◆ FillRects()

Renderer & SDL2pp::Renderer::FillRects	(	const Rect *	rects,
		int	count
	)

Fill multiple rectangles on the current rendering target.

Parameters

[in]	rects	Array of rectangles to draw
[in]	count	Number of rectangles

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderFillRects

◆ Get()

SDL_Renderer * SDL2pp::Renderer::Get ( ) const

Get pointer to managed SDL_Renderer structure.

Returns: Pointer to managed SDL_Renderer structure

◆ GetClipRect()

Optional< Rect > SDL2pp::Renderer::GetClipRect ( ) const

Get the clip rectangle for the current target.

Returns: Rect representing current clipping area or NullOpt if clipping is disabled

See also: http://wiki.libsdl.org/SDL_RenderGetClipRect

◆ GetDrawBlendMode()

SDL_BlendMode SDL2pp::Renderer::GetDrawBlendMode ( ) const

Get the blend mode used for drawing operations.

Returns: Current SDL_BlendMode

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_GetRenderDrawBlendMode

◆ GetDrawColor() [1/2]

Color SDL2pp::Renderer::GetDrawColor ( ) const

Get the additional color value multiplied into render copy operations.

Returns: Color object with the value used to do render copy operations

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_GetRenderDrawColor

◆ GetDrawColor() [2/2]

void SDL2pp::Renderer::GetDrawColor	(	Uint8 &	r,
		Uint8 &	g,
		Uint8 &	b,
		Uint8 &	a
	)		const

Get the additional color value multiplied into render copy operations.

Parameters

[out]	r	Variable to be filled in with red value used to draw on the rendering target
[out]	g	Variable to be filled in with green value used to draw on the rendering target
[out]	b	Variable to be filled in with blue value used to draw on the rendering target
[out]	a	Variable to be filled in with alpha value used to draw on the rendering target

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_GetRenderDrawColor

◆ GetInfo()

void SDL2pp::Renderer::GetInfo ( SDL_RendererInfo & info )

Get information about a rendering context.

Parameters

[out] info SDL_RendererInfo structure to be filled with information about the current renderer

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_GetRendererInfo

◆ GetLogicalHeight()

int SDL2pp::Renderer::GetLogicalHeight ( ) const

Get device independent width resolution for rendering.

Returns: Logical resolution height

See also: http://wiki.libsdl.org/SDL_RenderGetLogicalSize

Note: If this function is called on an Renderer who never had its logical size set by SetLogicalSize(), this function returns 0

◆ GetLogicalSize()

Point SDL2pp::Renderer::GetLogicalSize ( ) const

Get device independent resolution for rendering.

Returns: Point representing logical resolution

See also: http://wiki.libsdl.org/SDL_RenderGetLogicalSize

Note: If this function is called on an Renderer who never had its logical size set by SetLogicalSize(), this function returns {0, 0}

◆ GetLogicalWidth()

int SDL2pp::Renderer::GetLogicalWidth ( ) const

Get device independent width resolution for rendering.

Returns: Logical resolution width

See also: http://wiki.libsdl.org/SDL_RenderGetLogicalSize

Note: If this function is called on an Renderer who never had its logical size set by SetLogicalSize(), this function returns 0

◆ GetOutputHeight()

int SDL2pp::Renderer::GetOutputHeight ( ) const

Get the output height of a rendering context.

Returns: Output height

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_GetRendererOutputSize

◆ GetOutputSize()

Point SDL2pp::Renderer::GetOutputSize ( ) const

Get the output size of a rendering context.

Returns: Point representing output size

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_GetRendererOutputSize

◆ GetOutputWidth()

int SDL2pp::Renderer::GetOutputWidth ( ) const

Get the output width of a rendering context.

Returns: Output width

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_GetRendererOutputSize

◆ GetScale()

void SDL2pp::Renderer::GetScale	(	float &	scalex,
		float &	scaley
	)		const

Get the drawing scale for the current target.

Parameters

[out]	scalex	Variable to be filled with the horizontal scaling factor
[out]	scaley	Variable to be filled with the vertical scaling factor

See also: http://wiki.libsdl.org/SDL_RenderGetScale

◆ GetViewport()

Rect SDL2pp::Renderer::GetViewport ( ) const

Get the drawing area for the current target.

Returns: Rect representing current drawing area

See also: http://wiki.libsdl.org/SDL_RenderGetViewport

◆ GetXScale()

float SDL2pp::Renderer::GetXScale ( ) const

Get the drawing scale for the current target.

Returns: Horizontal scaling factor

See also: http://wiki.libsdl.org/SDL_RenderGetScale

◆ GetYScale()

float SDL2pp::Renderer::GetYScale ( ) const

Get the drawing scale for the current target.

Returns: Vertical scaling factor

See also: http://wiki.libsdl.org/SDL_RenderGetScale

◆ operator=() [1/2]

Renderer & SDL2pp::Renderer::operator= ( const Renderer & other )

delete

Deleted assignment operator.

This class is not copyable

◆ operator=() [2/2]

Renderer & SDL2pp::Renderer::operator= ( Renderer && other )

noexcept

Move assignment operator.

Parameters

[in] other SDL2pp::Renderer object to move data from

Returns: Reference to self

◆ Present()

Renderer & SDL2pp::Renderer::Present ( )

Update the screen with any rendering performed since the previous call.

SDL's rendering functions operate on a backbuffer; that is, calling a rendering function such as SDL_RenderDrawLine() does not directly put a line on the screen, but rather updates the backbuffer. As such, you compose your entire scene and present the composed backbuffer to the screen as a complete picture.

Therefore, when using SDL's rendering API, one does all drawing intended for the frame, and then calls this function once per frame to present the final drawing to the user.

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_RenderPresent

◆ ReadPixels()

void SDL2pp::Renderer::ReadPixels	(	const Optional< Rect > &	rect,
		Uint32	format,
		void *	pixels,
		int	pitch
	)

Read pixels from the current rendering target.

Parameters

[in]	rect	Area to read or NullOpt for the entire render target
[in]	format	Desired format of the pixel data, or 0 to use the format of the rendering target
[in]	pixels	Pointer to memory to be filled with pixel data
[in]	pitch	Number of bytes in a row of pixel data, including padding between lines

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderReadPixels

◆ SetClipRect()

Renderer & SDL2pp::Renderer::SetClipRect ( const Optional< Rect > & rect = NullOpt )

Set the clipping rectangle for rendering.

Parameters

[in] rect New clipping rectangle or NullOpt to disable clipping

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderSetClipRect

◆ SetDrawBlendMode()

Renderer & SDL2pp::Renderer::SetDrawBlendMode ( SDL_BlendMode blendMode = SDL_BLENDMODE_NONE )

Set the blend mode used for drawing operations.

Parameters

[in] blendMode SDL_BlendMode to use for blending

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_BlendMode; http://wiki.libsdl.org/SDL_SetRenderDrawBlendMode

◆ SetDrawColor() [1/2]

Renderer & SDL2pp::Renderer::SetDrawColor ( const Color & color )

Set color user for drawing operations.

Parameters

[in] color Color to draw on the rendering target

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_SetRenderDrawColor

◆ SetDrawColor() [2/2]

Renderer & SDL2pp::Renderer::SetDrawColor	(	Uint8	r = `0`,
		Uint8	g = `0`,
		Uint8	b = `0`,
		Uint8	a = `255`
	)

Set color user for drawing operations.

Parameters

[in]	r	Red value used to draw on the rendering target
[in]	g	Green value used to draw on the rendering target
[in]	b	Blue value used to draw on the rendering target
[in]	a	Alpha value used to draw on the rendering target

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_SetRenderDrawColor

◆ SetLogicalSize()

Renderer & SDL2pp::Renderer::SetLogicalSize	(	int	w,
		int	h
	)

Set a device independent resolution for rendering.

Parameters

[in]	w	Width of the logical resolution
[in]	h	Height of the logical resolution

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderSetLogicalSize

◆ SetScale()

Renderer & SDL2pp::Renderer::SetScale	(	float	scaleX,
		float	scaleY
	)

Set the drawing scale for rendering on the current target.

Parameters

[in]	scaleX	Horizontal scaling factor
[in]	scaleY	Vertical scaling factor

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderSetScale

◆ SetTarget() [1/2]

Renderer & SDL2pp::Renderer::SetTarget ( )

Set current render target to default.

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_SetRenderTarget

◆ SetTarget() [2/2]

Renderer & SDL2pp::Renderer::SetTarget ( Texture & texture )

Set current render target to specified texture.

Parameters

[in] texture Target texture, SDL2pp::Texture created with SDL_TEXTUREACCESS_TARGET

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_SetRenderTarget

◆ SetViewport()

Renderer & SDL2pp::Renderer::SetViewport ( const Optional< Rect > & rect = NullOpt )

Set the drawing area for rendering on the current target.

Parameters

[in] rect Rectangle representing the drawing area or NullOpt to set the viewport to the entire target

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_RenderSetViewport

◆ TargetSupported()

bool SDL2pp::Renderer::TargetSupported ( ) const

Determine whether a window supports the use of render targets.

Returns: True if render targets are supported

See also: http://wiki.libsdl.org/SDL_RenderTargetSupported

The documentation for this class was generated from the following files:

SDL2pp/Renderer.hh
SDL2pp/Renderer.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Renderer() [1/4]

◆ Renderer() [2/4]

◆ ~Renderer()

◆ Renderer() [3/4]

◆ Renderer() [4/4]

Member Function Documentation

◆ Clear()

◆ Copy() [1/4]

◆ Copy() [2/4]

◆ Copy() [3/4]

◆ Copy() [4/4]

◆ DrawLine() [1/2]

◆ DrawLine() [2/2]

◆ DrawLines()

◆ DrawPoint() [1/2]

◆ DrawPoint() [2/2]

◆ DrawPoints()

◆ DrawRect() [1/3]

◆ DrawRect() [2/3]

◆ DrawRect() [3/3]

◆ DrawRects()

◆ FillCopy()

◆ FillRect() [1/3]

◆ FillRect() [2/3]

◆ FillRect() [3/3]

◆ FillRects()

◆ Get()

◆ GetClipRect()

◆ GetDrawBlendMode()

◆ GetDrawColor() [1/2]

◆ GetDrawColor() [2/2]

◆ GetInfo()

◆ GetLogicalHeight()

◆ GetLogicalSize()

◆ GetLogicalWidth()

◆ GetOutputHeight()

◆ GetOutputSize()

◆ GetOutputWidth()

◆ GetScale()

◆ GetViewport()

◆ GetXScale()

◆ GetYScale()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Present()

◆ ReadPixels()

◆ SetClipRect()

◆ SetDrawBlendMode()

◆ SetDrawColor() [1/2]

◆ SetDrawColor() [2/2]

◆ SetLogicalSize()

◆ SetScale()

◆ SetTarget() [1/2]

◆ SetTarget() [2/2]

◆ SetViewport()

◆ TargetSupported()