Mercurial > sdl-ios-xcode
view docs/html/sdlvideoinfo.html @ 3341:710139a1692d
Fixed bug #826
Ken Bull 2009-10-04 09:51:30 PDT
2009/10/4 E. Wing <ewmailing@gmail.com>:
> Hi Kenneth,
> I noticed that SDL_SetColorKey and SDL_GetColorKey start with
> /*
> instead of
> /**
> in SDL_Surface.h in SDL 1.3.
>
> I haven't scrutinized the headers and I don't know if you had an
> automated process to add these, but I thought I would let you know in
> case there might be others that have the same problem.
>
> Thanks,
> Eric
>
The attached patch corrects this and other documentation errors in
SDL_surface.h
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sun, 04 Oct 2009 19:14:30 +0000 |
parents | 355632dca928 |
children |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_VideoInfo</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ "><LINK REL="HOME" TITLE="SDL Library Documentation" HREF="index.html"><LINK REL="UP" TITLE="Video" HREF="video.html"><LINK REL="PREVIOUS" TITLE="SDL_Surface" HREF="sdlsurface.html"><LINK REL="NEXT" TITLE="SDL_Overlay" HREF="sdloverlay.html"></HEAD ><BODY CLASS="REFENTRY" BGCOLOR="#FFF8DC" TEXT="#000000" LINK="#0000ee" VLINK="#551a8b" ALINK="#ff0000" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >SDL Library Documentation</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="sdlsurface.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdloverlay.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLVIDEOINFO" ></A >SDL_VideoInfo</H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN3390" ></A ><H2 >Name</H2 >SDL_VideoInfo -- Video Target information</DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3393" ></A ><H2 >Structure Definition</H2 ><PRE CLASS="PROGRAMLISTING" >typedef struct{ Uint32 hw_available:1; Uint32 wm_available:1; Uint32 blit_hw:1; Uint32 blit_hw_CC:1; Uint32 blit_hw_A:1; Uint32 blit_sw:1; Uint32 blit_sw_CC:1; Uint32 blit_sw_A:1; Uint32 blit_fill; Uint32 video_mem; SDL_PixelFormat *vfmt; } SDL_VideoInfo;</PRE ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3396" ></A ><H2 >Structure Data</H2 ><DIV CLASS="INFORMALTABLE" ><A NAME="AEN3398" ></A ><P ></P ><TABLE BORDER="0" CLASS="CALSTABLE" ><TBODY ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >hw_available</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Is it possible to create hardware surfaces?</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >wm_available</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Is there a window manager available</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >blit_hw</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Are hardware to hardware blits accelerated?</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >blit_hw_CC</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Are hardware to hardware colorkey blits accelerated?</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >blit_hw_A</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Are hardware to hardware alpha blits accelerated?</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >blit_sw</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Are software to hardware blits accelerated?</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >blit_sw_CC</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Are software to hardware colorkey blits accelerated?</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >blit_sw_A</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Are software to hardware alpha blits accelerated?</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >blit_fill</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Are color fills accelerated?</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >video_mem</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Total amount of video memory in Kilobytes</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >vfmt</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" ><A HREF="sdlpixelformat.html" >Pixel format</A > of the video device</TD ></TR ></TBODY ></TABLE ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3446" ></A ><H2 >Description</H2 ><P >This (read-only) structure is returned by <A HREF="sdlgetvideoinfo.html" ><TT CLASS="FUNCTION" >SDL_GetVideoInfo</TT ></A >. It contains information on either the 'best' available mode (if called before <A HREF="sdlsetvideomode.html" ><TT CLASS="FUNCTION" >SDL_SetVideoMode</TT ></A >) or the current video mode.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3453" ></A ><H2 >See Also</H2 ><P ><A HREF="sdlpixelformat.html" ><SPAN CLASS="STRUCTNAME" >SDL_PixelFormat</SPAN ></A >, <A HREF="sdlgetvideoinfo.html" ><TT CLASS="FUNCTION" >SDL_GetVideoInfo</TT ></A ></P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="sdlsurface.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="sdloverlay.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SDL_Surface</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="video.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_Overlay</TD ></TR ></TABLE ></DIV ></BODY ></HTML >