Sdl_window Struct Reference

#include <sdl_window.hpp>

Collaboration diagram for Sdl_window:

Public Member Functions
	Sdl_window (bool double_buffer=false)
	Sdl_window (const char *title, int x, int y, int w, int h, Uint32 flags, bool double_buffer=false)
	Sdl_window (const Sdl_window &)=delete
	Sdl_window (Sdl_window &&o)
	~Sdl_window ()
SDL_GLContext	get_worker_context ()
void	make_render_context_current ()
void	make_worker_context_current ()
Sdl_window &	operator= (const Sdl_window &)=delete
Sdl_window &	operator= (Sdl_window &&o)
void	set_title (const std::string &title)
void	swap (Sdl_window &o)

Public Attributes
int	height
SDL_GLContext	sdl_gl_context
SDL_GLContext	sdl_gl_worker_context = nullptr
SDL_Window *	sdl_window
int	width

Detailed Description

RAII wrapper for Sdl window

Definition at line 64 of file sdl_window.hpp.

Constructor & Destructor Documentation

Sdl_window() [1/4]

Sdl_window::Sdl_window

(

bool

double_buffer = false

)

Creates a window using default parameters.

Parameters

double_buffer

Controls the double buffering. If true, the default is used, if false it is disabled

Definition at line 41 of file sdl_window.cpp.

                                         : Sdl_window("UltraGrid",
                SDL_WINDOWPOS_CENTERED,
                SDL_WINDOWPOS_CENTERED,
                640,
                480,
                SDL_WINDOW_OPENGL | SDL_WINDOW_RESIZABLE, double_buffer) {  }

Sdl_window() [2/4]

Sdl_window::Sdl_window	(	const char *	title,
		int	x,
		int	y,
		int	w,
		int	h,
		Uint32	flags,
		bool	double_buffer = false )

Creates a window.

Parameters

title	window title
x	x position of the window, for centering SDL_WINDOWPOS_CENTERED can be passed
y	y position of the window, for centering SDL_WINDOWPOS_CENTERED can be passed
w	width of window
h	height of window
flags	Sdl flags for window creation
double_buffer	Controls the double buffering. If true, the default is used, if false it is disabled

Definition at line 48 of file sdl_window.cpp.

                                                  : width(w), height(h)
{
        SDL_InitSubSystem(SDL_INIT_VIDEO);
        SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_CORE);
        SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 3);
        SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 3);
 
        if(!double_buffer)
                SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 0);
 
        sdl_window = SDL_CreateWindow(title,
                        x,
                        y,
                        w,
                        h,
                        flags);
 
        if(!sdl_window){
                throw std::runtime_error("Failed to create SDL window!");
        }
 
        SDL_SetWindowMinimumSize(sdl_window, 200, 200);
 
        sdl_gl_context = SDL_GL_CreateContext(sdl_window);
        if(!sdl_gl_context){
                throw std::runtime_error("Failed to create gl context!");
        }
 
#ifndef __APPLE__
        glewExperimental = GL_TRUE;
        GLenum glewError = glewInit();
        if(glewError != GLEW_OK){
                throw std::runtime_error("Failed to initialize gl context!");
        }
#endif //__APPLE__
 
        glClearColor(0,0,0,1);
        glClear(GL_COLOR_BUFFER_BIT);
        SDL_GL_SwapWindow(sdl_window);
}

References flags, sdl_gl_context, and sdl_window.

~Sdl_window()

Sdl_window::~Sdl_window

(

)

Definition at line 92 of file sdl_window.cpp.

                       {
        SDL_GL_DeleteContext(sdl_gl_context);
        SDL_GL_DeleteContext(sdl_gl_worker_context);
        SDL_DestroyWindow(sdl_window);
        SDL_QuitSubSystem(SDL_INIT_VIDEO);
}

References sdl_gl_context, sdl_gl_worker_context, and sdl_window.

Sdl_window() [3/4]

Sdl_window::Sdl_window ( const Sdl_window & )

delete

Sdl_window() [4/4]

Sdl_window::Sdl_window ( Sdl_window && o )

inline

Definition at line 94 of file sdl_window.hpp.

{ swap(o); }

References swap().

Here is the call graph for this function:

Member Function Documentation

get_worker_context()

SDL_GLContext Sdl_window::get_worker_context

(

)

Returns the underlying worker context object. If it doesn'ŧ yet exists it gets created. Should be called at least once from the rendering thread before the worker thread starts.

Definition at line 120 of file sdl_window.cpp.

                                            {
        if(!sdl_gl_worker_context){
                SDL_GL_MakeCurrent(sdl_window, sdl_gl_context);
                SDL_GL_SetAttribute(SDL_GL_SHARE_WITH_CURRENT_CONTEXT, 1);
                sdl_gl_worker_context = SDL_GL_CreateContext(sdl_window);
                SDL_GL_SetAttribute(SDL_GL_SHARE_WITH_CURRENT_CONTEXT, 1);
                SDL_GL_MakeCurrent(sdl_window, sdl_gl_context);
        }
 
        return sdl_gl_worker_context;
}

References sdl_gl_context, sdl_gl_worker_context, and sdl_window.

Referenced by make_worker_context_current().

make_render_context_current()

void Sdl_window::make_render_context_current

(

)

If using multiple OpenGL contexts for multithreading this function makes the render context current

Definition at line 111 of file sdl_window.cpp.

                                            {
        SDL_GL_MakeCurrent(sdl_window, sdl_gl_context);
}

References sdl_gl_context, and sdl_window.

Referenced by display_xrgl_run().

make_worker_context_current()

void Sdl_window::make_worker_context_current

(

)

If using multiple OpenGL contexts for multithreading this function makes the worker context current

Definition at line 115 of file sdl_window.cpp.

                                            {
        SDL_GLContext worker_context = get_worker_context();
        SDL_GL_MakeCurrent(sdl_window, worker_context);
}

References get_worker_context(), and sdl_window.

Referenced by display_xrgl_run(), and worker().

Here is the call graph for this function:

operator=() [1/2]

Sdl_window & Sdl_window::operator= ( const Sdl_window & )

delete

operator=() [2/2]

Sdl_window & Sdl_window::operator= ( Sdl_window && o )

inline

Definition at line 96 of file sdl_window.hpp.

{ swap(o); return *this; }

References swap().

Here is the call graph for this function:

set_title()

void Sdl_window::set_title ( const std::string & title )

inline

Sets window title

Parameters

title

Title to use

Definition at line 112 of file sdl_window.hpp.

                                              {
                SDL_SetWindowTitle(sdl_window, title.c_str());
        }

References sdl_window.

swap()

void Sdl_window::swap

(

Sdl_window &

o

)

Definition at line 132 of file sdl_window.cpp.

                                  {
        std::swap(sdl_window, o.sdl_window);
        std::swap(sdl_gl_context, o.sdl_gl_context);
        std::swap(width, o.width);
        std::swap(height, o.height);
}

References height, sdl_gl_context, sdl_window, and width.

Referenced by Sdl_window(), and operator=().

Member Data Documentation

height

int Sdl_window::height

Definition at line 141 of file sdl_window.hpp.

Referenced by display_xrgl_run(), draw(), handle_window_event(), and swap().

sdl_gl_context

SDL_GLContext Sdl_window::sdl_gl_context

Definition at line 138 of file sdl_window.hpp.

Referenced by Sdl_window(), ~Sdl_window(), get_worker_context(), make_render_context_current(), and swap().

sdl_gl_worker_context

SDL_GLContext Sdl_window::sdl_gl_worker_context = nullptr

Definition at line 139 of file sdl_window.hpp.

Referenced by ~Sdl_window(), and get_worker_context().

sdl_window

SDL_Window* Sdl_window::sdl_window

Definition at line 137 of file sdl_window.hpp.

Referenced by Sdl_window(), ~Sdl_window(), display_xrgl_run(), draw(), get_worker_context(), handle_keyboard_event(), make_render_context_current(), make_worker_context_current(), set_title(), and swap().

width

int Sdl_window::width

Definition at line 140 of file sdl_window.hpp.

Referenced by display_xrgl_run(), draw(), handle_window_event(), and swap().

---

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

• src/video_display/sdl_window.hpp
• src/video_display/sdl_window.cpp