Man pages?

Are there man pages on the SDL functions somewhere? Like on the web?
I downloaded the 1.0.2 rpm and I’ve been playing with some demo
programs…
but when I have a question like , “What does SDL_ConvertSurface()” do or

“Does SDL_BlitSurface()” return NULL if the image is too big for
the screen or does it clip? where do I go?

-wabe

Are there man pages on the SDL functions somewhere? Like on the web?
I downloaded the 1.0.2 rpm and I’ve been playing with some demo
programs…
but when I have a question like , “What does SDL_ConvertSurface()” do or

“Does SDL_BlitSurface()” return NULL if the image is too big for
the screen or does it clip? where do I go?

There is HTML documentation in the source and development packages in
the docs subdirectory. You can also find it online at the SDL website:
http://www.devolution.com/~slouken/SDL/

See ya!
-Sam Lantinga (slouken at devolution.com)

Lead Programmer, Loki Entertainment Software–
“Any sufficiently advanced bug is indistinguishable from a feature”
– Rich Kulawiec

Are there man pages on the SDL functions somewhere? Like on the web?
I downloaded the 1.0.2 rpm and I’ve been playing with some demo
programs…
but when I have a question like , “What does SDL_ConvertSurface()” do or

“Does SDL_BlitSurface()” return NULL if the image is too big for
the screen or does it clip? where do I go?

I don’t think there are man pages yet, but there’s a very good "Introduction"
as well as a pretty complete API reference on the SDL website!!!

http://www.devolution.com/~slouken/SDL/

-bill!

It’s got a html-documentation. If it’s installed somewhere where you can’t
find it try “locate funclist.html” as that’s one of the pages.

The docs are also online at http://www.devolution.com/~slouken/SDL/ .

All the best,
robOn Tue, Jan 25, 2000 at 02:20:51PM -0500, wabe wrote:

Are there man pages on the SDL functions somewhere? Like on the web?

Are there man pages on the SDL functions somewhere? Like on the web?
I downloaded the 1.0.2 rpm and I’ve been playing with some demo
programs…
but when I have a question like , “What does SDL_ConvertSurface()” do or

“Does SDL_BlitSurface()” return NULL if the image is too big for
the screen or does it clip? where do I go?

-wabe

The closest thing I can think of is the API reference on the main page.
That, and looking through the demo apps :slight_smile:
This would be a neat (and very useful) project. I’d be happy to throw in
some stuff. But is a man page format really the best option?On Tuesday, January 25, 2000 1:21 PM, wabe [SMTP:wabe at home.com] wrote:

wabe wrote:

Are there man pages on the SDL functions somewhere? Like on the web?
I downloaded the 1.0.2 rpm and I’ve been playing with some demo
programs…
but when I have a question like , “What does SDL_ConvertSurface()” do or

“Does SDL_BlitSurface()” return NULL if the image is too big for
the screen or does it clip? where do I go?

-wabe

Hmm, I’ve been wondering some of the same things :wink: The documentation on
the website (which is the same, afaik) seems to be rather incomplete in
someplaces about what the defined behaviour is for some of these types of
things. Mostly, myself, I’ve been playing around.

Which leads me to my next question: I noticed that if I have an image that I
blit past the edge of the window, a part of the image disappears (i.e. my
image that I am blitting is smaller than the destination surface, but the
destination rectangle that I defined happens to go past the edge of the
screen), and doesn’t seem to reappear with subsequent blits that are
entirely on the screen.
Here is what I am guessing is happening: I blit using “SDL_BlitSurface(box,
NULL, screen, &block);” Tell me if I’m wrong: when SDL clips the blit, it
actually changes block.w and block.h, right? So before subsequent blits I
need to reset block.w and block.h to their original values, no?

Thanks in advance, Jeff Schmidt–
“Message sent by @Jeff_Schmidt

Which leads me to my next question: I noticed that if I have an image that I
blit past the edge of the window, a part of the image disappears (i.e. my
image that I am blitting is smaller than the destination surface, but the
destination rectangle that I defined happens to go past the edge of the
screen), and doesn’t seem to reappear with subsequent blits that are
entirely on the screen.
Here is what I am guessing is happening: I blit using “SDL_BlitSurface(box,
NULL, screen, &block);” Tell me if I’m wrong: when SDL clips the blit, it
actually changes block.w and block.h, right? So before subsequent blits I
need to reset block.w and block.h to their original values, no?

That’s correct.
This behavior is so that you can pass the blit rectangle directly to
SDL_UpdateRects() without having to duplicate the clipping yourself.

-Sam Lantinga				(slouken at devolution.com)

Lead Programmer, Loki Entertainment Software–
“Any sufficiently advanced bug is indistinguishable from a feature”
– Rich Kulawiec

Sam Lantinga wrote:

That’s correct.
This behavior is so that you can pass the blit rectangle directly to
SDL_UpdateRects() without having to duplicate the clipping yourself.

    -Sam Lantinga                           (slouken at devolution.com)

Lead Programmer, Loki Entertainment Software

“Any sufficiently advanced bug is indistinguishable from a feature”
– Rich Kulawiec

Ok :slight_smile: Thank you for responding so quickly. How do you manage to send so much
correspondence to the list and still find time to get real work done? :wink: Anyhow,
thank you.

Jeff Schmidt–
“Message sent by @Jeff_Schmidt

Sam Lantinga wrote:

That’s correct.
This behavior is so that you can pass the blit rectangle directly to
SDL_UpdateRects() without having to duplicate the clipping yourself.

    -Sam Lantinga                           (slouken at devolution.com)

Lead Programmer, Loki Entertainment Software

“Any sufficiently advanced bug is indistinguishable from a feature”
– Rich Kulawiec

Ok :slight_smile: Thank you for responding so quickly. How do you manage to send so much
correspondence to the list and still find time to get real work done? :wink: Anyhow,
thank you.

Well, luckily the last week or so has been devoted to upgrading the SDL
X11 driver, so I’ve been in the thick of things. :slight_smile:

-Sam Lantinga				(slouken at devolution.com)

Lead Programmer, Loki Entertainment Software–
“Any sufficiently advanced bug is indistinguishable from a feature”
– Rich Kulawiec

how does one go about making a man page?

wabe wrote:> Are there man pages on the SDL functions somewhere? Like on the web?

I downloaded the 1.0.2 rpm and I’ve been playing with some demo
programs…
but when I have a question like , “What does SDL_ConvertSurface()” do or

“Does SDL_BlitSurface()” return NULL if the image is too big for
the screen or does it clip? where do I go?

-wabe

This may help you create a man page:

http://www.linuxdoc.org/HOWTO/mini/Man-Page.html

Robert> -----Original Message-----

From: Jess [SMTP:jessh at lbjhs.net]
Sent: 26. januar 2000 11:38
To: sdl at lokigames.com
Subject: [SDL] Re: man pages?

how does one go about making a man page?

wabe wrote:

Are there man pages on the SDL functions somewhere? Like on the web?
I downloaded the 1.0.2 rpm and I’ve been playing with some demo
programs…
but when I have a question like , “What does SDL_ConvertSurface()” do or

“Does SDL_BlitSurface()” return NULL if the image is too big for
the screen or does it clip? where do I go?

-wabe

“Archbold, David W.” wrote:

Are there man pages on the SDL functions somewhere? Like on the web?
I downloaded the 1.0.2 rpm and I’ve been playing with some demo
programs…
but when I have a question like , “What does SDL_ConvertSurface()” do or

“Does SDL_BlitSurface()” return NULL if the image is too big for
the screen or does it clip? where do I go?

-wabe

The closest thing I can think of is the API reference on the main page.
That, and looking through the demo apps :slight_smile:
This would be a neat (and very useful) project. I’d be happy to throw in
some stuff. But is a man page format really the best option?

Better than that would be to convert the hodgepodge of HTML files we
have describing SDL into a more common documentation format like
TeXinfo, where we can have all of the documentation easily convertible
to any number of other formats (DVI for printed manuals, Info for local
documentation, and HTML for web-based docs of course). I think you can
even make man pages out of TeXinfo docs if that’s useful. I don’t think
SGML will do, not now, not with the present state of SGML-tools,
although pedagogically I think that it would be a better choice than
TeXinfo.> On Tuesday, January 25, 2000 1:21 PM, wabe [SMTP:wabe at home.com] wrote:

| Rafael R. Sevilla @Rafael_R_Sevilla |
| Instrumentation, Robotics, and Control Laboratory |

College of Engineering, University of the Philippines, Diliman

Hi everyone,

I installed SDL-1.0.3, smpeg 0.3.3 and SDL_mixer-1.0.3 in
that order on a RedHat 6.0 box (I’ve given up trying on
my main box which is running RedHat 5.2)

After the installs, I could use both plaympeg and playmus to play
mp3 files. I did not specify "–enable-mixer"
when I built smpeg, and playmus had no trouble with the mp3.

So, what does the “–enable-mixer” smpeg configure switch do, exactly?
I thought that was needed to enable SDL_mixer to recognize files in
mp3 format, but it seems to work without the switch being explicitly
invoked.

I’m not too worried about it, just curious if I’ve missed something
else…

Steve Madsen
H2Eye Ltd
24-28 Hatton Wall
London EC1N 8JH
Tel: +44-171-404-9600
Fax: +44-171-404-9490
Email: @Steve_Madsen

So, what does the “–enable-mixer” smpeg configure switch do, exactly?

It’s for when you build a program that uses SDL_mixer and wants to play
MPEG videos - it tells SMPEG not to create it’s own music output, but that
it will be called explicitly by the mixer library.

-Sam Lantinga				(slouken at devolution.com)

Lead Programmer, Loki Entertainment Software–
“Any sufficiently advanced bug is indistinguishable from a feature”
– Rich Kulawiec

The closest thing I can think of is the API reference on the main page.
That, and looking through the demo apps :slight_smile:
This would be a neat (and very useful) project. I’d be happy to throw in
some stuff. But is a man page format really the best option?

Better than that would be to convert the hodgepodge of HTML files we
have describing SDL into a more common documentation format like
TeXinfo, where we can have all of the documentation easily convertible
to any number of other formats (DVI for printed manuals, Info for local
documentation, and HTML for web-based docs of course). I think you can
even make man pages out of TeXinfo docs if that’s useful. I don’t think
SGML will do, not now, not with the present state of SGML-tools,
although pedagogically I think that it would be a better choice than
TeXinfo.

I’d say that the SGML-tools are better suited than the TeXinfo suite,
TeXinfo is a wee bit obscure for such a diverse audience as SDL isn’t it?
Maybe not. But converting from the existing HTML to SGML would be relatively
simple, only a couple of hours work to do the lot. I had a go at the API docs,
it doesn’t take much, just some cut & pasting/regexp replace and you’re done.

The only real issue is getting a maintainer for it, since Sam probably doesn’t
want the hassle.

Andre