Re: Porting SDL2 to a new platform, detailed docs?

Sam Lantinga <[email protected]> Mon, 20 Feb 2017 22:33:30 -0800
Newsgroups gmane.comp.lib.sdl
Message-ID <CACC3sbH9EOaDnfZ1Dm93sOTJSw=31OKc-SMvCMXMzABmQ+ND-Q@mail.gmail.com>
--===============4347304223136540274==
Content-Type: multipart/alternative; boundary=001a114388ccf414ec0549048e24

--001a114388ccf414ec0549048e24
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

New platforms are rare enough that nobody has written detailed
documentation on how to add one, especially since platforms besides the
desktop OSes are extremely unique. There isn't a standard reference
document other than the API documentation. When in doubt, check the
behavior of your favorite desktop platform.

As Jonathan said, your best bet is to look at a platform that is closest to
yours, and see what is done there.

Feel free to ask lots of questions on the mailing list and create the
document you wanted. :)

On Sun, Feb 19, 2017 at 1:41 PM, Arne Schwettmann <[email protected]=
m
> wrote:

> Hello SDL developers,
> I want to help in porting SDL2 to a new platform. I am new to this, and I
> would greatly appreciate help from somebody who has done this before
> (porting to Android or other platforms where SDL2 now exists).
>
> I have the following question:
> - Is there a standard reference document that includes all the functions
> with implementation details*? I need something telling me which system
> level functions (drivers) I have to implement, detailing their desired
> behaviour (input/output etc.)?
>
> *ideally this should be a long, indexed, pdf and not a bunch of disjointe=
d
> comments in source or a bunch of disjointed comments/readme=E2=80=99s on =
GitHub :)
>
> What I have found:
>
> So far I have found this
> https://forums.libsdl.org/viewtopic.php?p=3D3591&sid=3D
> ca6328caf29e567ac498a6d32ae4399a
>
> , and some comments in the driver source for SDL2 for other platforms. Bu=
t
> surely that can=E2=80=99t be all the documentation for a decade old proje=
ct?
>
> To clarify: None of the content at https://wiki.libsdl.org is of use to
> me, since it is at the user level. I need docs at the driver/internal lev=
el
> of the API. I am looking at documentation at the developer level for
> porting the SDL2 library itself, not documentation at the user level for
> using an existing SDL2 port for a project.
>
> Thank you very much for any help in advance,
> Arne
>
> _______________________________________________
> SDL mailing list
> [email protected]
> http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
>
>

--001a114388ccf414ec0549048e24
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">New platforms are rare enough that nobody has written deta=
iled documentation on how to add one, especially since platforms besides th=
e desktop OSes are extremely unique. There isn&#39;t a standard reference d=
ocument other than the API documentation. When in doubt, check the behavior=
 of your favorite desktop platform.<div><br></div><div>As Jonathan said, yo=
ur best bet is to look at a platform that is closest to yours, and see what=
 is done there.</div><div><br></div><div>Feel free to ask lots of questions=
 on the mailing list and create the document you wanted. :)</div></div><div=
 class=3D"gmail_extra"><br><div class=3D"gmail_quote">On Sun, Feb 19, 2017 =
at 1:41 PM, Arne Schwettmann <span dir=3D"ltr">&lt;<a href=3D"mailto:arnesc=
[email protected]" target=3D"_blank">[email protected]</a>&gt;</s=
pan> wrote:<br><blockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex=
;border-left:1px #ccc solid;padding-left:1ex"><div style=3D"word-wrap:break=
-word"><div>Hello SDL developers,</div>I want to help in porting SDL2 to a =
new platform. I am new to this, and I would greatly appreciate help from so=
mebody who has done this before (porting to Android or other platforms wher=
e SDL2 now exists).<div><br></div><div>I have the following question:<br><d=
iv>- Is there a standard reference document that includes all the functions=
 with implementation details*? I need something telling me which system lev=
el functions (drivers) I have to implement, detailing their desired behavio=
ur (input/output etc.)?</div><div><br></div><div>*ideally this should be a =
long, indexed, pdf and not a bunch of disjointed comments in source or a bu=
nch of disjointed comments/readme=E2=80=99s on GitHub :)</div><div><br></di=
v><div>What I have found:</div><div><br></div><div>So far I have found this=
</div><div><a href=3D"https://forums.libsdl.org/viewtopic.php?p=3D3591&amp;=
sid=3Dca6328caf29e567ac498a6d32ae4399a" target=3D"_blank">https://forums.li=
bsdl.org/<wbr>viewtopic.php?p=3D3591&amp;sid=3D<wbr>ca6328caf29e567ac498a6d=
32ae439<wbr>9a</a></div><div><br></div><div>, and some comments in the driv=
er source for SDL2 for other platforms. But surely that can=E2=80=99t be al=
l the documentation for a decade old project?</div><div><br></div><div>To c=
larify: None of the content at=C2=A0<a href=3D"https://wiki.libsdl.org" tar=
get=3D"_blank">https://wiki.libsdl.org</a>=C2=A0is of use to me, since it i=
s at the user level. I need docs at the driver/internal level of the API. I=
 am looking at documentation at the developer level for porting the SDL2 li=
brary itself, not documentation at the user level for using an existing SDL=
2 port for a project.=C2=A0</div><div><br></div><div><div>Thank you very mu=
ch for any help in advance,</div></div><div>Arne</div></div></div><br>_____=
_________________________<wbr>_________________<br>
SDL mailing list<br>
<a href=3D"mailto:[email protected]">[email protected]</a><br>
<a href=3D"http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org" rel=3D"nore=
ferrer" target=3D"_blank">http://lists.libsdl.org/<wbr>listinfo.cgi/sdl-lib=
sdl.org</a><br>
<br></blockquote></div><br></div>

--001a114388ccf414ec0549048e24--

--===============4347304223136540274==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
SDL mailing list
[email protected]
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org

--===============4347304223136540274==--