Skip to content

Commit 373eee3

Browse files
committed
split main module POD into .pod
1 parent 1d8e22f commit 373eee3

File tree

4 files changed

+86
-87
lines changed

4 files changed

+86
-87
lines changed

MANIFEST

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ include/GL/glew.h
77
include/GL/glxew.h
88
include/GL/wglew.h
99
lib/OpenGL/Modern.pm
10+
lib/OpenGL/Modern.pod
1011
lib/OpenGL/Modern.xs
1112
lib/OpenGL/Modern/Const.pm
1213
lib/OpenGL/Modern/Const.xs

Makefile.PL

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ WriteConfigPM({ LIBS => $libs || $DYNS->{OTHERLDFLAGS} });
3030
WriteMakefile(
3131
NAME => 'OpenGL::Modern',
3232
VERSION_FROM => 'lib/OpenGL/Modern.pm',
33-
ABSTRACT_FROM => 'lib/OpenGL/Modern.pm',
33+
ABSTRACT_FROM => 'lib/OpenGL/Modern.pod',
3434
AUTHOR => 'Chris Marshall <[email protected]>',
3535
LICENSE => 'perl',
3636
PREREQ_PM => {

lib/OpenGL/Modern.pm

Lines changed: 0 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -13235,89 +13235,3 @@ require XSLoader;
1323513235
XSLoader::load( __PACKAGE__, $XS_VERSION );
1323613236

1323713237
1;
13238-
13239-
__END__
13240-
13241-
=head1 NAME
13242-
13243-
OpenGL::Modern - Perl extension to Modern OpenGL API up to 4.5
13244-
13245-
=head1 SYNOPSIS
13246-
13247-
use OpenGL::Modern qw(:all);
13248-
use OpenGL qw(:glutfunctions :glutconstants); # for GLUT
13249-
13250-
=head1 DESCRIPTION
13251-
13252-
C<OpenGL::Modern> provides perl bindings to the OpenGL
13253-
graphics APIs using the OpenGL Extension Wrangler (GLEW)
13254-
library. These bindings were largely generated by parsing
13255-
the GLEW include file, C<glew.h>.
13256-
13257-
This module updates the original Perl OpenGL bindings
13258-
L<OpenGL> (often abbreviated as POGL) to include support
13259-
for all OpenGL API from 1.0 through 4.5. The "modern"
13260-
OpenGL APIs are those starting with version 3.1 and higher.
13261-
13262-
OpenGL 3.1 was the first version where the legacy OpenGL
13263-
functionality from versions 1.x-3.0 was fully deprecated.
13264-
Much of the functionality that used to be accessed via the
13265-
extension mechanism in C<OpenGL> now is standardized and
13266-
in the OpenGL Core APIs.
13267-
13268-
=head2 OpenGL::Image
13269-
13270-
The module OpenGL::Image was written for the original OpenGL.pm, however it can
13271-
be made to work seamlessly with OpenGL::Modern. Where-as you previously loaded
13272-
it like this:
13273-
13274-
use OpenGL::Image; # loads OpenGL.pm on its own
13275-
13276-
You can prepend two use lines, and get this:
13277-
13278-
use OpenGL::Array; # not part of OpenGL::Modern
13279-
use OpenGL::Modern::ImageHack; # sets up a fake OpenGL namespace
13280-
use OpenGL::Image; # now safe to do, won't load OpenGL.pm
13281-
13282-
=head2 EXPORT
13283-
13284-
None by default.
13285-
13286-
=head1 DEBUGGING
13287-
13288-
In development, you can call C<glpSetAutoCheckErrors(1)> which will have
13289-
each OpenGL function automatically call C<glGetErrors()> and report any
13290-
found. This is off by default for performance reasons.
13291-
13292-
=head1 SEE ALSO
13293-
13294-
OpenGL 4.x documentation at L<https://www.opengl.org/sdk/docs/man4/>
13295-
13296-
Perl OpenGL (POGL) and Perl OpenGL::Modern (POGL2) development
13297-
share common resources. At some point C<OpenGL::Modern> will
13298-
replace the legacy C<OpenGL> implementation. Together they are
13299-
referred to as POGL.
13300-
13301-
Perl OpenGL developer and users lists are at
13302-
L<https://sourceforge.net/p/pogl/mailman/?source=navbar>
13303-
13304-
Perl OpenGL IRC is at #pogl on irc.perl.org
13305-
13306-
POGL2 development will take place on github and the repository
13307-
is being set up there. The sf.net repository will be the official
13308-
release repository and is mirrored from github.
13309-
13310-
=head1 AUTHOR
13311-
13312-
Chris Marshall, E<lt> devel dot chm dot 01 AT gmail dot com E<gt>
13313-
13314-
=head1 LICENSE and COPYRIGHT
13315-
13316-
This library is free software; you can redistribute it and/or modify
13317-
it under the same terms as Perl itself, either Perl version 5.22.0 or,
13318-
at your option, any later version of Perl 5 you may have available.
13319-
13320-
Copyright (C) 2017 by Chris Marshall
13321-
Copyright (C) 2016 by Max Maischein
13322-
13323-
=cut

lib/OpenGL/Modern.pod

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
=head1 NAME
2+
3+
OpenGL::Modern - Perl extension to Modern OpenGL API up to 4.6
4+
5+
=head1 SYNOPSIS
6+
7+
use OpenGL::Modern qw(:all);
8+
use OpenGL qw(:glutfunctions :glutconstants); # for GLUT
9+
10+
=head1 DESCRIPTION
11+
12+
C<OpenGL::Modern> provides perl bindings to the OpenGL
13+
graphics APIs using the OpenGL Extension Wrangler (GLEW)
14+
library. These bindings were largely generated by parsing
15+
the GLEW include file, C<glew.h>, with additional information from
16+
the Khronos Registry.
17+
18+
This module updates the original Perl OpenGL bindings
19+
L<OpenGL> (often abbreviated as POGL) to include support
20+
for all OpenGL API from 1.0 through 4.6. The "modern"
21+
OpenGL APIs are those starting with version 3.1 and higher.
22+
23+
OpenGL 3.1 was the first version where the legacy OpenGL
24+
functionality from versions 1.x-3.0 was fully deprecated.
25+
Much of the functionality that used to be accessed via the
26+
extension mechanism in C<OpenGL> now is standardized and
27+
in the OpenGL Core APIs.
28+
29+
=head2 OpenGL::Image
30+
31+
The module OpenGL::Image was written for the original OpenGL.pm, however it can
32+
be made to work seamlessly with OpenGL::Modern. Where-as you previously loaded
33+
it like this:
34+
35+
use OpenGL::Image; # loads OpenGL.pm on its own
36+
37+
You can prepend two use lines, and get this:
38+
39+
use OpenGL::Array; # not part of OpenGL::Modern
40+
use OpenGL::Modern::ImageHack; # sets up a fake OpenGL namespace
41+
use OpenGL::Image; # now safe to do, won't load OpenGL.pm
42+
43+
=head2 EXPORT
44+
45+
None by default.
46+
47+
=head1 DEBUGGING
48+
49+
In development, you can call C<glpSetAutoCheckErrors(1)> which will have
50+
each OpenGL function automatically call C<glGetErrors()> and report any
51+
found. This is off by default for performance reasons.
52+
53+
=head1 SEE ALSO
54+
55+
OpenGL 4.x documentation at L<https://www.opengl.org/sdk/docs/man4/>
56+
57+
Perl OpenGL (POGL) and Perl OpenGL::Modern (POGL2) development
58+
share common resources. At some point C<OpenGL::Modern> will
59+
replace the legacy C<OpenGL> implementation. Together they are
60+
referred to as POGL.
61+
62+
Perl OpenGL developer and users lists are at
63+
L<https://sourceforge.net/p/pogl/mailman/?source=navbar>
64+
65+
Perl OpenGL IRC is at #pogl on irc.perl.org
66+
67+
POGL2 development will take place on github and the repository
68+
is being set up there. The sf.net repository will be the official
69+
release repository and is mirrored from github.
70+
71+
=head1 AUTHOR
72+
73+
Chris Marshall, E<lt> devel dot chm dot 01 AT gmail dot com E<gt>
74+
75+
=head1 LICENSE and COPYRIGHT
76+
77+
This library is free software; you can redistribute it and/or modify
78+
it under the same terms as Perl itself, either Perl version 5.22.0 or,
79+
at your option, any later version of Perl 5 you may have available.
80+
81+
Copyright (C) 2017 by Chris Marshall
82+
Copyright (C) 2016 by Max Maischein
83+
84+
=cut

0 commit comments

Comments
 (0)