Wiki Page Content

Differences between revisions 14 and 15
Revision 14 as of 2012-09-03 07:01:12
Size: 2844
Editor: ChrisBush
Comment:
Revision 15 as of 2012-12-22 07:12:41
Size: 2809
Editor: ChrisBush
Comment: someone was confused by window flags in the example
Deletions are marked like this. Additions are marked like this.
Line 43: Line 43:
  SDL_Window *pWindow; // Declare a pointer to an SDL_Window   SDL_Window *window; // Declare a pointer to an SDL_Window
Line 46: Line 46:
  pWindow = SDL_CreateWindow(
    "An SDL2 window", // const char* title
    SDL_WINDOWPOS_UNDEFINED, // int x: initial x position
    SDL_WINDOWPOS_UNDEFINED, // int y: initial y position
    640, // int w: width, in pixels
    480, // int h: height, in pixels
    SDL_WINDOW_SHOWN          // Uint32 flags: window options, see below
  window = SDL_CreateWindow(
    "An SDL2 window",          // window title
    SDL_WINDOWPOS_UNDEFINED,          // initial x position
    SDL_WINDOWPOS_UNDEFINED,          // initial y position
    640,          // width, in pixels
    480,          // height, in pixels
    SDL_WINDOW_SHOWN|SDL_WINDOW_OPENGL // flags - see below
Line 56: Line 56:
  if(pWindow==NULL){   if(window==NULL){
Line 67: Line 67:
  SDL_DestroyWindow(pWindow);   SDL_DestroyWindow(window);
Line 69: Line 69:
  // Uninitialize SDL2 and exit the program   // Clean up

SDL_CreateWindow

Use this function to create a window with the specified position, dimensions, and flags.

Syntax

SDL_Window* SDL_CreateWindow(const char* title,
                              int         x,
                              int         y,
                              int         w,
                              int         h,
                              Uint32      flags)

Function Parameters

title

the title of the window, in UTF-8 encoding

x

the x position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED

y

the y position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED

w

the width of the window

h

the height of the window

flags

0, or one or more SDL_WindowFlags OR'd together; see Remarks for details

Return Value

Returns the window that was created or NULL on failure; call SDL_GetError() for more information.

Code Examples

// Example program:
// Using SDL2 to create an application window

#include <SDL2/SDL.h>
#include <iostream>

int main(int argc, char* argv[]){

  SDL_Init(SDL_INIT_VIDEO);   // Initialize SDL2
  
  SDL_Window *window;        // Declare a pointer to an SDL_Window
  
  // Create an application window with the following settings:
  window = SDL_CreateWindow( 
    "An SDL2 window",                  //    window title
    SDL_WINDOWPOS_UNDEFINED,           //    initial x position
    SDL_WINDOWPOS_UNDEFINED,           //    initial y position
    640,                               //    width, in pixels
    480,                               //    height, in pixels
    SDL_WINDOW_SHOWN|SDL_WINDOW_OPENGL //    flags - see below
  );
  
  // Check that the window was successfully made
  if(window==NULL){   
    // In the event that the window could not be made...
    std::cout << "Could not create window: " << SDL_GetError() << '\n';
    return 1;
  }
  
  // The window is open: enter program loop (see SDL_PollEvent)

  SDL_Delay(3000);  // Pause execution for 3000 milliseconds, for example
  
  // Close and destroy the window
  SDL_DestroyWindow(window); 
   
  // Clean up
  SDL_Quit(); 
  return 0;   
 
}

Remarks

flags may be a mask of any of the following:

SDL_WINDOW_FULLSCREEN

SDL_WINDOW_OPENGL

SDL_WINDOW_SHOWN

SDL_WINDOW_BORDERLESS

SDL_WINDOW_RESIZABLE

SDL_WINDOW_MAXIMIZED

SDL_WINDOW_MINIMIZED

SDL_WINDOW_INPUT_GRABBED


CategoryAPI, CategoryVideo

None: SDL_CreateWindow (last edited 2018-09-04 21:50:13 by ninepoints)

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